Merge PR #3567: x/gov peer review

client/lcd/lcd_test.go

@@ -870,7 +870,7 @@ func TestVote(t *testing.T) {
 	require.Equal(t, gov.OptionYes, vote.Option)
 
 	tally := getTally(t, port, proposalID)
-	require.Equal(t, sdk.ZeroDec(), tally.Yes, "tally should be 0 as the address is not bonded")
+	require.Equal(t, sdk.ZeroInt(), tally.Yes, "tally should be 0 as the address is not bonded")
 
 	// create bond TX
 	delTokens := staking.TokensFromTendermintPower(60)
@@ -885,7 +885,7 @@ func TestVote(t *testing.T) {
 	expectedBalance = coins[0]
 
 	tally = getTally(t, port, proposalID)
-	require.Equal(t, sdk.NewDecFromInt(delTokens), tally.Yes, "tally should be equal to the amount delegated")
+	require.Equal(t, delTokens, tally.Yes, "tally should be equal to the amount delegated")
 
 	// change vote option
 	resultTx = doVote(t, port, seed, name1, pw, addr, proposalID, "No", fees)
@@ -897,8 +897,8 @@ func TestVote(t *testing.T) {
 	require.Equal(t, expectedBalance.Amount, acc.GetCoins().AmountOf(staking.DefaultBondDenom))
 
 	tally = getTally(t, port, proposalID)
-	require.Equal(t, sdk.ZeroDec(), tally.Yes, "tally should be 0 the user changed the option")
+	require.Equal(t, sdk.ZeroInt(), tally.Yes, "tally should be 0 the user changed the option")
-	require.Equal(t, sdk.NewDecFromInt(delTokens), tally.No, "tally should be equal to the amount delegated")
+	require.Equal(t, delTokens, tally.No, "tally should be equal to the amount delegated")
 }
 
 func TestUnjail(t *testing.T) {

x/gov/client/module_client.go

@@ -5,6 +5,7 @@ import (
 	amino "github.com/tendermint/go-amino"
 
 	"github.com/cosmos/cosmos-sdk/client"
+	"github.com/cosmos/cosmos-sdk/x/gov"
 	govCli "github.com/cosmos/cosmos-sdk/x/gov/client/cli"
 )
 
@@ -22,7 +23,7 @@ func NewModuleClient(storeKey string, cdc *amino.Codec) ModuleClient {
 func (mc ModuleClient) GetQueryCmd() *cobra.Command {
 	// Group gov queries under a subcommand
 	govQueryCmd := &cobra.Command{
-		Use:   "gov",
+		Use:   gov.ModuleName,
 		Short: "Querying commands for the governance module",
 	}
 
@@ -44,7 +45,7 @@ func (mc ModuleClient) GetQueryCmd() *cobra.Command {
 // GetTxCmd returns the transaction commands for this module
 func (mc ModuleClient) GetTxCmd() *cobra.Command {
 	govTxCmd := &cobra.Command{
-		Use:   "gov",
+		Use:   gov.ModuleName,
 		Short: "Governance transactions subcommands",
 	}
 

x/gov/client/rest/rest.go

@@ -56,10 +56,10 @@ func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router, cdc *codec.Codec)
 
 type postProposalReq struct {
 	BaseReq        rest.BaseReq   `json:"base_req"`
-	Title          string         `json:"title"`           //  Title of the proposal
+	Title          string         `json:"title"`           // Title of the proposal
-	Description    string         `json:"description"`     //  Description of the proposal
+	Description    string         `json:"description"`     // Description of the proposal
-	ProposalType   string         `json:"proposal_type"`   //  Type of proposal. Initial set {PlainTextProposal, SoftwareUpgradeProposal}
+	ProposalType   string         `json:"proposal_type"`   // Type of proposal. Initial set {PlainTextProposal, SoftwareUpgradeProposal}
-	Proposer       sdk.AccAddress `json:"proposer"`        //  Address of the proposer
+	Proposer       sdk.AccAddress `json:"proposer"`        // Address of the proposer
 	InitialDeposit sdk.Coins      `json:"initial_deposit"` // Coins to add to the proposal's deposit
 }
 
@@ -71,8 +71,8 @@ type depositReq struct {
 
 type voteReq struct {
 	BaseReq rest.BaseReq   `json:"base_req"`
-	Voter   sdk.AccAddress `json:"voter"`  //  address of the voter
+	Voter   sdk.AccAddress `json:"voter"`  // address of the voter
-	Option  string         `json:"option"` //  option from OptionSet chosen by the voter
+	Option  string         `json:"option"` // option from OptionSet chosen by the voter
 }
 
 func postProposalHandlerFn(cdc *codec.Codec, cliCtx context.CLIContext) http.HandlerFunc {

x/gov/depositsvotes.go

@@ -55,6 +55,9 @@ func (d Deposit) String() string {
 type Deposits []Deposit
 
 func (d Deposits) String() string {
+	if len(d) == 0 {
+		return "[]"
+	}
 	out := fmt.Sprintf("Deposits for Proposal %d:", d[0].ProposalID)
 	for _, dep := range d {
 		out += fmt.Sprintf("\n  %s: %s", dep.Depositor, dep.Amount)

x/gov/endblocker.go

@@ -0,0 +1,76 @@
+package gov
+
+import (
+	"fmt"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/gov/tags"
+)
+
+// Called every block, process inflation, update validator set
+func EndBlocker(ctx sdk.Context, keeper Keeper) sdk.Tags {
+	logger := ctx.Logger().With("module", "x/gov")
+	resTags := sdk.NewTags()
+
+	inactiveIterator := keeper.InactiveProposalQueueIterator(ctx, ctx.BlockHeader().Time)
+	defer inactiveIterator.Close()
+	for ; inactiveIterator.Valid(); inactiveIterator.Next() {
+		var proposalID uint64
+
+		keeper.cdc.MustUnmarshalBinaryLengthPrefixed(inactiveIterator.Value(), &proposalID)
+		inactiveProposal := keeper.GetProposal(ctx, proposalID)
+
+		keeper.DeleteProposal(ctx, proposalID)
+		keeper.DeleteDeposits(ctx, proposalID) // delete any associated deposits (burned)
+
+		resTags = resTags.AppendTag(tags.ProposalID, fmt.Sprintf("%d", proposalID))
+		resTags = resTags.AppendTag(tags.ProposalResult, tags.ActionProposalDropped)
+
+		logger.Info(
+			fmt.Sprintf("proposal %d (%s) didn't meet minimum deposit of %s (had only %s); deleted",
+				inactiveProposal.GetProposalID(),
+				inactiveProposal.GetTitle(),
+				keeper.GetDepositParams(ctx).MinDeposit,
+				inactiveProposal.GetTotalDeposit(),
+			),
+		)
+	}
+
+	// fetch active proposals whose voting periods have ended (are passed the block time)
+	activeIterator := keeper.ActiveProposalQueueIterator(ctx, ctx.BlockHeader().Time)
+	defer activeIterator.Close()
+	for ; activeIterator.Valid(); activeIterator.Next() {
+		var proposalID uint64
+
+		keeper.cdc.MustUnmarshalBinaryLengthPrefixed(activeIterator.Value(), &proposalID)
+		activeProposal := keeper.GetProposal(ctx, proposalID)
+		passes, tallyResults := tally(ctx, keeper, activeProposal)
+
+		var tagValue string
+		if passes {
+			keeper.RefundDeposits(ctx, activeProposal.GetProposalID())
+			activeProposal.SetStatus(StatusPassed)
+			tagValue = tags.ActionProposalPassed
+		} else {
+			keeper.DeleteDeposits(ctx, activeProposal.GetProposalID())
+			activeProposal.SetStatus(StatusRejected)
+			tagValue = tags.ActionProposalRejected
+		}
+
+		activeProposal.SetFinalTallyResult(tallyResults)
+		keeper.SetProposal(ctx, activeProposal)
+		keeper.RemoveFromActiveProposalQueue(ctx, activeProposal.GetVotingEndTime(), activeProposal.GetProposalID())
+
+		logger.Info(
+			fmt.Sprintf(
+				"proposal %d (%s) tallied; passed: %v",
+				activeProposal.GetProposalID(), activeProposal.GetTitle(), passes,
+			),
+		)
+
+		resTags = resTags.AppendTag(tags.ProposalID, fmt.Sprintf("%d", proposalID))
+		resTags = resTags.AppendTag(tags.ProposalResult, tagValue)
+	}
+
+	return resTags
+}

x/gov/errors.go

@@ -8,7 +8,7 @@ import (
 )
 
 const (
-	DefaultCodespace sdk.CodespaceType = "GOV"
+	DefaultCodespace sdk.CodespaceType = ModuleName
 
 	CodeUnknownProposal         sdk.CodeType = 1
 	CodeInactiveProposal        sdk.CodeType = 2
@@ -23,7 +23,6 @@ const (
 	CodeInvalidProposalStatus   sdk.CodeType = 11
 )
 
-//----------------------------------------
 // Error constructors
 
 func ErrUnknownProposal(codespace sdk.CodespaceType, proposalID uint64) sdk.Error {

x/gov/genesis.go

@@ -1,6 +1,7 @@
 package gov
 
 import (
+	"bytes"
 	"fmt"
 	"time"
 
@@ -8,6 +9,11 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/staking"
 )
 
+const (
+	// Default period for deposits & voting
+	DefaultPeriod time.Duration = 86400 * 2 * time.Second // 2 days
+)
+
 // GenesisState - all staking state that must be provided at genesis
 type GenesisState struct {
 	StartingProposalID uint64                `json:"starting_proposal_id"`
@@ -47,10 +53,10 @@ func DefaultGenesisState() GenesisState {
 		StartingProposalID: 1,
 		DepositParams: DepositParams{
 			MinDeposit:       sdk.Coins{sdk.NewCoin(staking.DefaultBondDenom, minDepositTokens)},
-			MaxDepositPeriod: time.Duration(172800) * time.Second,
+			MaxDepositPeriod: DefaultPeriod,
 		},
 		VotingParams: VotingParams{
-			VotingPeriod: time.Duration(172800) * time.Second,
+			VotingPeriod: DefaultPeriod,
 		},
 		TallyParams: TallyParams{
 			Quorum:            sdk.NewDecWithPrec(334, 3),
@@ -63,48 +69,9 @@ func DefaultGenesisState() GenesisState {
 
 // Checks whether 2 GenesisState structs are equivalent.
 func (data GenesisState) Equal(data2 GenesisState) bool {
-	if data.StartingProposalID != data2.StartingProposalID ||
+	b1 := msgCdc.MustMarshalBinaryBare(data)
-		!data.DepositParams.Equal(data2.DepositParams) ||
+	b2 := msgCdc.MustMarshalBinaryBare(data2)
-		data.VotingParams != data2.VotingParams ||
+	return bytes.Equal(b1, b2)
-		data.TallyParams != data2.TallyParams {
-		return false
-	}
-
-	if len(data.Deposits) != len(data2.Deposits) {
-		return false
-	}
-	for i := range data.Deposits {
-		deposit1 := data.Deposits[i]
-		deposit2 := data2.Deposits[i]
-		if deposit1.ProposalID != deposit2.ProposalID ||
-			!deposit1.Deposit.Equals(deposit2.Deposit) {
-			return false
-		}
-	}
-
-	if len(data.Votes) != len(data2.Votes) {
-		return false
-	}
-	for i := range data.Votes {
-		vote1 := data.Votes[i]
-		vote2 := data2.Votes[i]
-		if vote1.ProposalID != vote2.ProposalID ||
-			!vote1.Vote.Equals(vote2.Vote) {
-			return false
-		}
-	}
-
-	if len(data.Proposals) != len(data2.Proposals) {
-		return false
-	}
-	for i := range data.Proposals {
-		if !ProposalEqual(data.Proposals[i], data2.Proposals[i]) {
-			return false
-		}
-	}
-
-	return true
-
 }
 
 // Returns if a GenesisState is empty or has data in it
@@ -113,7 +80,7 @@ func (data GenesisState) IsEmpty() bool {
 	return data.Equal(emptyGenState)
 }
 
-// ValidateGenesis TODO https://github.com/cosmos/cosmos-sdk/issues/3007
+// ValidateGenesis
 func ValidateGenesis(data GenesisState) error {
 	threshold := data.TallyParams.Threshold
 	if threshold.IsNegative() || threshold.GT(sdk.OneDec()) {

x/gov/handler.go

@@ -83,72 +83,3 @@ func handleMsgVote(ctx sdk.Context, keeper Keeper, msg MsgVote) sdk.Result {
 		),
 	}
 }
-
-// Called every block, process inflation, update validator set
-func EndBlocker(ctx sdk.Context, keeper Keeper) sdk.Tags {
-	logger := ctx.Logger().With("module", "x/gov")
-	resTags := sdk.NewTags()
-
-	inactiveIterator := keeper.InactiveProposalQueueIterator(ctx, ctx.BlockHeader().Time)
-	for ; inactiveIterator.Valid(); inactiveIterator.Next() {
-		var proposalID uint64
-
-		keeper.cdc.MustUnmarshalBinaryLengthPrefixed(inactiveIterator.Value(), &proposalID)
-		inactiveProposal := keeper.GetProposal(ctx, proposalID)
-
-		keeper.DeleteProposal(ctx, proposalID)
-		keeper.DeleteDeposits(ctx, proposalID) // delete any associated deposits (burned)
-
-		resTags = resTags.AppendTag(tags.ProposalID, fmt.Sprintf("%d", proposalID))
-		resTags = resTags.AppendTag(tags.ProposalResult, tags.ActionProposalDropped)
-
-		logger.Info(
-			fmt.Sprintf("proposal %d (%s) didn't meet minimum deposit of %s (had only %s); deleted",
-				inactiveProposal.GetProposalID(),
-				inactiveProposal.GetTitle(),
-				keeper.GetDepositParams(ctx).MinDeposit,
-				inactiveProposal.GetTotalDeposit(),
-			),
-		)
-	}
-
-	inactiveIterator.Close()
-
-	activeIterator := keeper.ActiveProposalQueueIterator(ctx, ctx.BlockHeader().Time)
-	for ; activeIterator.Valid(); activeIterator.Next() {
-		var proposalID uint64
-
-		keeper.cdc.MustUnmarshalBinaryLengthPrefixed(activeIterator.Value(), &proposalID)
-		activeProposal := keeper.GetProposal(ctx, proposalID)
-		passes, tallyResults := tally(ctx, keeper, activeProposal)
-
-		var tagValue string
-		if passes {
-			keeper.RefundDeposits(ctx, activeProposal.GetProposalID())
-			activeProposal.SetStatus(StatusPassed)
-			tagValue = tags.ActionProposalPassed
-		} else {
-			keeper.DeleteDeposits(ctx, activeProposal.GetProposalID())
-			activeProposal.SetStatus(StatusRejected)
-			tagValue = tags.ActionProposalRejected
-		}
-
-		activeProposal.SetFinalTallyResult(tallyResults)
-		keeper.SetProposal(ctx, activeProposal)
-		keeper.RemoveFromActiveProposalQueue(ctx, activeProposal.GetVotingEndTime(), activeProposal.GetProposalID())
-
-		logger.Info(
-			fmt.Sprintf(
-				"proposal %d (%s) tallied; passed: %v",
-				activeProposal.GetProposalID(), activeProposal.GetTitle(), passes,
-			),
-		)
-
-		resTags = resTags.AppendTag(tags.ProposalID, fmt.Sprintf("%d", proposalID))
-		resTags = resTags.AppendTag(tags.ProposalResult, tagValue)
-	}
-
-	activeIterator.Close()
-
-	return resTags
-}

x/gov/keeper.go

@@ -12,17 +12,20 @@ import (
 )
 
 const (
+	// ModuleKey is the name of the module
+	ModuleName = "gov"
+
 	// StoreKey is the store key string for gov
-	StoreKey = "gov"
+	StoreKey = ModuleName
 
 	// RouterKey is the message route for gov
-	RouterKey = "gov"
+	RouterKey = ModuleName
 
 	// QuerierRoute is the querier route for gov
-	QuerierRoute = "gov"
+	QuerierRoute = ModuleName
 
 	// Parameter store default namestore
-	DefaultParamspace = "gov"
+	DefaultParamspace = ModuleName
 )
 
 // Parameter store key
@@ -31,6 +34,7 @@ var (
 	ParamStoreKeyVotingParams  = []byte("votingparams")
 	ParamStoreKeyTallyParams   = []byte("tallyparams")
 
+	// TODO: Find another way to implement this without using accounts, or find a cleaner way to implement it using accounts.
 	DepositedCoinsAccAddr     = sdk.AccAddress(crypto.AddressHash([]byte("govDepositedCoins")))
 	BurnedDepositCoinsAccAddr = sdk.AccAddress(crypto.AddressHash([]byte("govBurnedDepositCoins")))
 )
@@ -89,7 +93,6 @@ func NewKeeper(cdc *codec.Codec, key sdk.StoreKey, paramsKeeper params.Keeper, p
 	}
 }
 
-// =====================================================
 // Proposals
 
 // Creates a NewProposal
@@ -124,10 +127,8 @@ func (keeper Keeper) GetProposal(ctx sdk.Context, proposalID uint64) Proposal {
 	if bz == nil {
 		return nil
 	}
-
 	var proposal Proposal
 	keeper.cdc.MustUnmarshalBinaryLengthPrefixed(bz, &proposal)
-
 	return proposal
 }
 
@@ -148,6 +149,10 @@ func (keeper Keeper) DeleteProposal(ctx sdk.Context, proposalID uint64) {
 }
 
 // Get Proposal from store by ProposalID
+// voterAddr will filter proposals by whether or not that address has voted on them
+// depositorAddr will filter proposals by whether or not that address has deposited to them
+// status will filter proposals by status
+// numLatest will fetch a specified number of the most recent proposals, or 0 for all proposals
 func (keeper Keeper) GetProposalsFiltered(ctx sdk.Context, voterAddr sdk.AccAddress, depositorAddr sdk.AccAddress, status ProposalStatus, numLatest uint64) []Proposal {
 
 	maxProposalID, err := keeper.peekCurrentProposalID(ctx)
@@ -192,6 +197,7 @@ func (keeper Keeper) GetProposalsFiltered(ctx sdk.Context, voterAddr sdk.AccAddr
 	return matchingProposals
 }
 
+// Set the initial proposal ID
 func (keeper Keeper) setInitialProposalID(ctx sdk.Context, proposalID uint64) sdk.Error {
 	store := ctx.KVStore(keeper.storeKey)
 	bz := store.Get(KeyNextProposalID)
@@ -248,11 +254,9 @@ func (keeper Keeper) activateVotingPeriod(ctx sdk.Context, proposal Proposal) {
 	keeper.InsertActiveProposalQueue(ctx, proposal.GetVotingEndTime(), proposal.GetProposalID())
 }
 
-// =====================================================
 // Params
 
 // Returns the current DepositParams from the global param store
-// nolint: errcheck
 func (keeper Keeper) GetDepositParams(ctx sdk.Context) DepositParams {
 	var depositParams DepositParams
 	keeper.paramSpace.Get(ctx, ParamStoreKeyDepositParams, &depositParams)
@@ -260,7 +264,6 @@ func (keeper Keeper) GetDepositParams(ctx sdk.Context) DepositParams {
 }
 
 // Returns the current VotingParams from the global param store
-// nolint: errcheck
 func (keeper Keeper) GetVotingParams(ctx sdk.Context) VotingParams {
 	var votingParams VotingParams
 	keeper.paramSpace.Get(ctx, ParamStoreKeyVotingParams, &votingParams)
@@ -268,29 +271,24 @@ func (keeper Keeper) GetVotingParams(ctx sdk.Context) VotingParams {
 }
 
 // Returns the current TallyParam from the global param store
-// nolint: errcheck
 func (keeper Keeper) GetTallyParams(ctx sdk.Context) TallyParams {
 	var tallyParams TallyParams
 	keeper.paramSpace.Get(ctx, ParamStoreKeyTallyParams, &tallyParams)
 	return tallyParams
 }
 
-// nolint: errcheck
 func (keeper Keeper) setDepositParams(ctx sdk.Context, depositParams DepositParams) {
 	keeper.paramSpace.Set(ctx, ParamStoreKeyDepositParams, &depositParams)
 }
 
-// nolint: errcheck
 func (keeper Keeper) setVotingParams(ctx sdk.Context, votingParams VotingParams) {
 	keeper.paramSpace.Set(ctx, ParamStoreKeyVotingParams, &votingParams)
 }
 
-// nolint: errcheck
 func (keeper Keeper) setTallyParams(ctx sdk.Context, tallyParams TallyParams) {
 	keeper.paramSpace.Set(ctx, ParamStoreKeyTallyParams, &tallyParams)
 }
 
-// =====================================================
 // Votes
 
 // Adds a vote on a specific proposal
@@ -346,7 +344,6 @@ func (keeper Keeper) deleteVote(ctx sdk.Context, proposalID uint64, voterAddr sd
 	store.Delete(KeyVote(proposalID, voterAddr))
 }
 
-// =====================================================
 // Deposits
 
 // Gets the deposit of a specific depositor on a specific proposal
@@ -382,17 +379,17 @@ func (keeper Keeper) AddDeposit(ctx sdk.Context, proposalID uint64, depositorAdd
 	}
 
 	// Send coins from depositor's account to DepositedCoinsAccAddr account
+	// TODO: Don't use an account for this purpose; it's clumsy and prone to misuse.
 	_, err := keeper.ck.SendCoins(ctx, depositorAddr, DepositedCoinsAccAddr, depositAmount)
 	if err != nil {
 		return err, false
 	}
 
-	// Update Proposal
+	// Update proposal
 	proposal.SetTotalDeposit(proposal.GetTotalDeposit().Plus(depositAmount))
 	keeper.SetProposal(ctx, proposal)
 
-	// Check if deposit tipped proposal into voting period
+	// Check if deposit has provided sufficient total funds to transition the proposal into the voting period
-	// Active voting period if so
 	activatedVotingPeriod := false
 	if proposal.GetStatus() == StatusDepositPeriod && proposal.GetTotalDeposit().IsAllGTE(keeper.GetDepositParams(ctx).MinDeposit) {
 		keeper.activateVotingPeriod(ctx, proposal)
@@ -412,13 +409,13 @@ func (keeper Keeper) AddDeposit(ctx sdk.Context, proposalID uint64, depositorAdd
 	return nil, activatedVotingPeriod
 }
 
-// Gets all the deposits on a specific proposal
+// Gets all the deposits on a specific proposal as an sdk.Iterator
 func (keeper Keeper) GetDeposits(ctx sdk.Context, proposalID uint64) sdk.Iterator {
 	store := ctx.KVStore(keeper.storeKey)
 	return sdk.KVStorePrefixIterator(store, KeyDepositsSubspace(proposalID))
 }
 
-// Returns and deletes all the deposits on a specific proposal
+// Refunds and deletes all the deposits on a specific proposal
 func (keeper Keeper) RefundDeposits(ctx sdk.Context, proposalID uint64) {
 	store := ctx.KVStore(keeper.storeKey)
 	depositsIterator := keeper.GetDeposits(ctx, proposalID)
@@ -445,6 +442,7 @@ func (keeper Keeper) DeleteDeposits(ctx sdk.Context, proposalID uint64) {
 		deposit := &Deposit{}
 		keeper.cdc.MustUnmarshalBinaryLengthPrefixed(depositsIterator.Value(), deposit)
 
+		// TODO: Find a way to do this without using accounts.
 		_, err := keeper.ck.SendCoins(ctx, DepositedCoinsAccAddr, BurnedDepositCoinsAccAddr, deposit.Amount)
 		if err != nil {
 			panic("should not happen")
@@ -454,7 +452,6 @@ func (keeper Keeper) DeleteDeposits(ctx sdk.Context, proposalID uint64) {
 	}
 }
 
-// =====================================================
 // ProposalQueues
 
 // Returns an iterator for all the proposals in the Active Queue that expire by endTime

x/gov/keeper_keys.go

@@ -8,8 +8,6 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
-// TODO remove some of these prefixes once have working multistore
-
 // Key for getting a the next available proposalID from the store
 var (
 	KeyDelimiter = []byte(":")

x/gov/msgs.go

@@ -18,7 +18,6 @@ const (
 
 var _, _, _ sdk.Msg = MsgSubmitProposal{}, MsgDeposit{}, MsgVote{}
 
-//-----------------------------------------------------------
 // MsgSubmitProposal
 type MsgSubmitProposal struct {
 	Title          string         `json:"title"`           //  Title of the proposal
@@ -28,7 +27,7 @@ type MsgSubmitProposal struct {
 	InitialDeposit sdk.Coins      `json:"initial_deposit"` //  Initial deposit paid by sender. Must be strictly positive.
 }
 
-func NewMsgSubmitProposal(title string, description string, proposalType ProposalKind, proposer sdk.AccAddress, initialDeposit sdk.Coins) MsgSubmitProposal {
+func NewMsgSubmitProposal(title, description string, proposalType ProposalKind, proposer sdk.AccAddress, initialDeposit sdk.Coins) MsgSubmitProposal {
 	return MsgSubmitProposal{
 		Title:          title,
 		Description:    description,
@@ -75,11 +74,6 @@ func (msg MsgSubmitProposal) String() string {
 	return fmt.Sprintf("MsgSubmitProposal{%s, %s, %s, %v}", msg.Title, msg.Description, msg.ProposalType, msg.InitialDeposit)
 }
 
-// Implements Msg.
-func (msg MsgSubmitProposal) Get(key interface{}) (value interface{}) {
-	return nil
-}
-
 // Implements Msg.
 func (msg MsgSubmitProposal) GetSignBytes() []byte {
 	bz := msgCdc.MustMarshalJSON(msg)
@@ -91,7 +85,6 @@ func (msg MsgSubmitProposal) GetSigners() []sdk.AccAddress {
 	return []sdk.AccAddress{msg.Proposer}
 }
 
-//-----------------------------------------------------------
 // MsgDeposit
 type MsgDeposit struct {
 	ProposalID uint64         `json:"proposal_id"` // ID of the proposal
@@ -114,7 +107,7 @@ func (msg MsgDeposit) Type() string  { return TypeMsgDeposit }
 
 // Implements Msg.
 func (msg MsgDeposit) ValidateBasic() sdk.Error {
-	if len(msg.Depositor) == 0 {
+	if msg.Depositor.Empty() {
 		return sdk.ErrInvalidAddress(msg.Depositor.String())
 	}
 	if !msg.Amount.IsValid() {
@@ -133,11 +126,6 @@ func (msg MsgDeposit) String() string {
 	return fmt.Sprintf("MsgDeposit{%s=>%v: %v}", msg.Depositor, msg.ProposalID, msg.Amount)
 }
 
-// Implements Msg.
-func (msg MsgDeposit) Get(key interface{}) (value interface{}) {
-	return nil
-}
-
 // Implements Msg.
 func (msg MsgDeposit) GetSignBytes() []byte {
 	bz := msgCdc.MustMarshalJSON(msg)
@@ -149,7 +137,6 @@ func (msg MsgDeposit) GetSigners() []sdk.AccAddress {
 	return []sdk.AccAddress{msg.Depositor}
 }
 
-//-----------------------------------------------------------
 // MsgVote
 type MsgVote struct {
 	ProposalID uint64         `json:"proposal_id"` // ID of the proposal
@@ -188,11 +175,6 @@ func (msg MsgVote) String() string {
 	return fmt.Sprintf("MsgVote{%v - %s}", msg.ProposalID, msg.Option)
 }
 
-// Implements Msg.
-func (msg MsgVote) Get(key interface{}) (value interface{}) {
-	return nil
-}
-
 // Implements Msg.
 func (msg MsgVote) GetSignBytes() []byte {
 	bz := msgCdc.MustMarshalJSON(msg)

x/gov/params.go

@@ -7,7 +7,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
-// Param around Deposits for governance
+// Param around deposits for governance
 type DepositParams struct {
 	MinDeposit       sdk.Coins     `json:"min_deposit"`        //  Minimum deposit for a proposal to enter voting period.
 	MaxDepositPeriod time.Duration `json:"max_deposit_period"` //  Maximum period for Atom holders to deposit on a proposal. Initial value: 2 months

x/gov/proposals.go

@@ -9,7 +9,6 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
-//-----------------------------------------------------------
 // Proposal interface
 type Proposal interface {
 	GetProposalID() uint64
@@ -79,7 +78,6 @@ func ProposalEqual(proposalA Proposal, proposalB Proposal) bool {
 	return false
 }
 
-//-----------------------------------------------------------
 // Text Proposals
 type TextProposal struct {
 	ProposalID   uint64       `json:"proposal_id"`   //  ID of the proposal
@@ -147,11 +145,9 @@ func (tp TextProposal) String() string {
 		tp.TotalDeposit, tp.VotingStartTime, tp.VotingEndTime)
 }
 
-//-----------------------------------------------------------
 // ProposalQueue
 type ProposalQueue []uint64
 
-//-----------------------------------------------------------
 // ProposalKind
 
 // Type that represents Proposal Type as a byte
@@ -165,7 +161,7 @@ const (
 	ProposalTypeSoftwareUpgrade ProposalKind = 0x03
 )
 
-// String to proposalType byte.  Returns ff if invalid.
+// String to proposalType byte. Returns 0xff if invalid.
 func ProposalTypeFromString(str string) (ProposalKind, error) {
 	switch str {
 	case "Text":
@@ -247,7 +243,6 @@ func (pt ProposalKind) Format(s fmt.State, verb rune) {
 	}
 }
 
-//-----------------------------------------------------------
 // ProposalStatus
 
 // Type that represents Proposal Status as a byte
@@ -351,16 +346,15 @@ func (status ProposalStatus) Format(s fmt.State, verb rune) {
 	}
 }
 
-//-----------------------------------------------------------
 // Tally Results
 type TallyResult struct {
-	Yes        sdk.Dec `json:"yes"`
+	Yes        sdk.Int `json:"yes"`
-	Abstain    sdk.Dec `json:"abstain"`
+	Abstain    sdk.Int `json:"abstain"`
-	No         sdk.Dec `json:"no"`
+	No         sdk.Int `json:"no"`
-	NoWithVeto sdk.Dec `json:"no_with_veto"`
+	NoWithVeto sdk.Int `json:"no_with_veto"`
 }
 
-func NewTallyResult(yes, abstain, no, noWithVeto sdk.Dec) TallyResult {
+func NewTallyResult(yes, abstain, no, noWithVeto sdk.Int) TallyResult {
 	return TallyResult{
 		Yes:        yes,
 		Abstain:    abstain,
@@ -371,20 +365,20 @@ func NewTallyResult(yes, abstain, no, noWithVeto sdk.Dec) TallyResult {
 
 func NewTallyResultFromMap(results map[VoteOption]sdk.Dec) TallyResult {
 	return TallyResult{
-		Yes:        results[OptionYes],
+		Yes:        results[OptionYes].TruncateInt(),
-		Abstain:    results[OptionAbstain],
+		Abstain:    results[OptionAbstain].TruncateInt(),
-		No:         results[OptionNo],
+		No:         results[OptionNo].TruncateInt(),
-		NoWithVeto: results[OptionNoWithVeto],
+		NoWithVeto: results[OptionNoWithVeto].TruncateInt(),
 	}
 }
 
 // checks if two proposals are equal
 func EmptyTallyResult() TallyResult {
 	return TallyResult{
-		Yes:        sdk.ZeroDec(),
+		Yes:        sdk.ZeroInt(),
-		Abstain:    sdk.ZeroDec(),
+		Abstain:    sdk.ZeroInt(),
-		No:         sdk.ZeroDec(),
+		No:         sdk.ZeroInt(),
-		NoWithVeto: sdk.ZeroDec(),
+		NoWithVeto: sdk.ZeroInt(),
 	}
 }
 

x/gov/tally.go

@@ -6,25 +6,26 @@ import (
 
 // validatorGovInfo used for tallying
 type validatorGovInfo struct {
-	Address         sdk.ValAddress // address of the validator operator
+	Address             sdk.ValAddress // address of the validator operator
-	BondedTokens    sdk.Int        // Power of a Validator
+	BondedTokens        sdk.Int        // Power of a Validator
-	DelegatorShares sdk.Dec        // Total outstanding delegator shares
+	DelegatorShares     sdk.Dec        // Total outstanding delegator shares
-	Minus           sdk.Dec        // Minus of validator, used to compute validator's voting power
+	DelegatorDeductions sdk.Dec        // Delegator deductions from validator's delegators voting independently
-	Vote            VoteOption     // Vote of the validator
+	Vote                VoteOption     // Vote of the validator
 }
 
 func newValidatorGovInfo(address sdk.ValAddress, bondedTokens sdk.Int, delegatorShares,
-	minus sdk.Dec, vote VoteOption) validatorGovInfo {
+	delegatorDeductions sdk.Dec, vote VoteOption) validatorGovInfo {
 
 	return validatorGovInfo{
-		Address:         address,
+		Address:             address,
-		BondedTokens:    bondedTokens,
+		BondedTokens:        bondedTokens,
-		DelegatorShares: delegatorShares,
+		DelegatorShares:     delegatorShares,
-		Minus:           minus,
+		DelegatorDeductions: delegatorDeductions,
-		Vote:            vote,
+		Vote:                vote,
 	}
 }
 
+// TODO: Break into several smaller functions for clarity
 func tally(ctx sdk.Context, keeper Keeper, proposal Proposal) (passes bool, tallyResults TallyResult) {
 	results := make(map[VoteOption]sdk.Dec)
 	results[OptionYes] = sdk.ZeroDec()
@@ -35,6 +36,7 @@ func tally(ctx sdk.Context, keeper Keeper, proposal Proposal) (passes bool, tall
 	totalVotingPower := sdk.ZeroDec()
 	currValidators := make(map[string]validatorGovInfo)
 
+	// fetch all the bonded validators, insert them into currValidators
 	keeper.vs.IterateBondedValidatorsByPower(ctx, func(index int64, validator sdk.Validator) (stop bool) {
 		currValidators[validator.GetOperator().String()] = newValidatorGovInfo(
 			validator.GetOperator(),
@@ -60,12 +62,12 @@ func tally(ctx sdk.Context, keeper Keeper, proposal Proposal) (passes bool, tall
 			val.Vote = vote.Option
 			currValidators[valAddrStr] = val
 		} else {
-
+			// iterate over all delegations from voter, deduct from any delegated-to validators
 			keeper.ds.IterateDelegations(ctx, vote.Voter, func(index int64, delegation sdk.Delegation) (stop bool) {
 				valAddrStr := delegation.GetValidatorAddr().String()
 
 				if val, ok := currValidators[valAddrStr]; ok {
-					val.Minus = val.Minus.Add(delegation.GetShares())
+					val.DelegatorDeductions = val.DelegatorDeductions.Add(delegation.GetShares())
 					currValidators[valAddrStr] = val
 
 					delegatorShare := delegation.GetShares().Quo(val.DelegatorShares)
@@ -88,9 +90,9 @@ func tally(ctx sdk.Context, keeper Keeper, proposal Proposal) (passes bool, tall
 			continue
 		}
 
-		sharesAfterMinus := val.DelegatorShares.Sub(val.Minus)
+		sharesAfterDeductions := val.DelegatorShares.Sub(val.DelegatorDeductions)
-		percentAfterMinus := sharesAfterMinus.Quo(val.DelegatorShares)
+		fractionAfterDeductions := sharesAfterDeductions.Quo(val.DelegatorShares)
-		votingPower := percentAfterMinus.MulInt(val.BondedTokens)
+		votingPower := fractionAfterDeductions.MulInt(val.BondedTokens)
 
 		results[val.Vote] = results[val.Vote].Add(votingPower)
 		totalVotingPower = totalVotingPower.Add(votingPower)
@@ -99,6 +101,7 @@ func tally(ctx sdk.Context, keeper Keeper, proposal Proposal) (passes bool, tall
 	tallyParams := keeper.GetTallyParams(ctx)
 	tallyResults = NewTallyResultFromMap(results)
 
+	// TODO: Upgrade the spec to cover all of these cases & remove pseudocode.
 	// If there is no staked coins, the proposal fails
 	if keeper.vs.TotalPower(ctx).IsZero() {
 		return false, tallyResults