mirror of
				https://github.com/0glabs/0g-chain.git
				synced 2025-11-04 14:17:28 +00:00 
			
		
		
		
	* Committee types (#899) * committee types * refactor to committee interface * include tokencommitee stringer method * add members to BaseCommittee * address revisions * update querier * update querier * fix compilation errors, tests, etc. * Update MsgVote with vote type (#900) * add vote to msg * update querier/rest * update example cli vote msg * remove incorrect comments * address revisions * update handler, stub keeper method * add vote type to vote struct * Committee module keeper logic for token holder governance (#902) * fix keeper/test compilation errors * fix keeper/test compilation errors pt 2 * add setters to committee interface * fix sims compilation errors * fix incentive tests compilation errors * update types, expected keepers * core keeper logic * don't allow bond denom * implement vote tallying * query proposal polling status * update module keepers in app.go * register committee interface * fix failing incentive test * commitee types tests * refactor GetProposalResult by committee types * update invariants * implement most proposal keeper tests * add nulls to custom enums * remove abstain vote type * add test for close proposal * remove outdated TODOs * update ProcessProposals * switch on committee type directly * reintroduce Abstain votes and update vote tallying * don't allow divide by 0 panics * delete unused setters on committee interface * clean up tally methods return values for querier * update enum validation to catch negative ints * reintroduce setters for sims compilation * address revisions * remove commented out test * implement ProcessProposals test * additional revisions * Committee migrations (#909) * add committee v14 legacy types * update migration imports for compile * addRegisterCodec() to committee v14 legacy types * migrate committee genesis state from v14 to v15 * set stability committee permissions properly * fix committee allowed params * migration test, kava-7 sample data * add concrete types to committees (#911) * revisions: migrate + tests * register msgs on legacy codec * Prepare Committee module for migrations (#906) * remove invariants * edits * fix abci test * fix keeper querier tests * add committee interface registration * use codec.Codec * don't allow null vote types * don't allow null tally option * minor spelling fixes * update example cli proposal * fix cli tally query * enable vote abstain from cli * include vote options in cli help text * call CloseProposal from handler * custom enum marshaling * committee: fix failing tests (#921) * fix failing tests * fix: spelling Co-authored-by: rhuairahrighairigh <ruaridh.odonnell@gmail.com> Co-authored-by: Ruaridh <rhuairahrighairidh@users.noreply.github.com> Co-authored-by: Kevin Davis <karzak@users.noreply.github.com>
		
			
				
	
	
		
			327 lines
		
	
	
		
			9.6 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			327 lines
		
	
	
		
			9.6 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
package keeper_test
 | 
						|
 | 
						|
import (
 | 
						|
	"strings"
 | 
						|
	"testing"
 | 
						|
	"time"
 | 
						|
 | 
						|
	"github.com/stretchr/testify/suite"
 | 
						|
 | 
						|
	"github.com/cosmos/cosmos-sdk/codec"
 | 
						|
	sdk "github.com/cosmos/cosmos-sdk/types"
 | 
						|
	"github.com/cosmos/cosmos-sdk/x/gov"
 | 
						|
	"github.com/cosmos/cosmos-sdk/x/params"
 | 
						|
 | 
						|
	abci "github.com/tendermint/tendermint/abci/types"
 | 
						|
 | 
						|
	"github.com/kava-labs/kava/app"
 | 
						|
	"github.com/kava-labs/kava/x/committee/keeper"
 | 
						|
	"github.com/kava-labs/kava/x/committee/types"
 | 
						|
)
 | 
						|
 | 
						|
const (
 | 
						|
	custom = "custom"
 | 
						|
)
 | 
						|
 | 
						|
var testTime time.Time = time.Date(1998, time.January, 1, 0, 0, 0, 0, time.UTC)
 | 
						|
 | 
						|
type QuerierTestSuite struct {
 | 
						|
	suite.Suite
 | 
						|
 | 
						|
	keeper keeper.Keeper
 | 
						|
	app    app.TestApp
 | 
						|
	ctx    sdk.Context
 | 
						|
	cdc    *codec.Codec
 | 
						|
 | 
						|
	querier sdk.Querier
 | 
						|
 | 
						|
	addresses   []sdk.AccAddress
 | 
						|
	testGenesis types.GenesisState
 | 
						|
	votes       map[uint64]([]types.Vote)
 | 
						|
}
 | 
						|
 | 
						|
func (suite *QuerierTestSuite) SetupTest() {
 | 
						|
	suite.app = app.NewTestApp()
 | 
						|
	suite.keeper = suite.app.GetCommitteeKeeper()
 | 
						|
	suite.ctx = suite.app.NewContext(true, abci.Header{})
 | 
						|
	suite.cdc = suite.app.Codec()
 | 
						|
	suite.querier = keeper.NewQuerier(suite.keeper)
 | 
						|
 | 
						|
	_, suite.addresses = app.GeneratePrivKeyAddressPairs(5)
 | 
						|
	suite.testGenesis = types.NewGenesisState(
 | 
						|
		3,
 | 
						|
		[]types.Committee{
 | 
						|
			types.MemberCommittee{
 | 
						|
				BaseCommittee: types.BaseCommittee{
 | 
						|
					ID:               1,
 | 
						|
					Description:      "This committee is for testing.",
 | 
						|
					Members:          suite.addresses[:3],
 | 
						|
					Permissions:      []types.Permission{types.GodPermission{}},
 | 
						|
					VoteThreshold:    d("0.667"),
 | 
						|
					ProposalDuration: time.Hour * 24 * 7,
 | 
						|
					TallyOption:      types.FirstPastThePost,
 | 
						|
				},
 | 
						|
			},
 | 
						|
			types.MemberCommittee{
 | 
						|
				BaseCommittee: types.BaseCommittee{
 | 
						|
					ID:               2,
 | 
						|
					Members:          suite.addresses[2:],
 | 
						|
					Permissions:      nil,
 | 
						|
					VoteThreshold:    d("0.667"),
 | 
						|
					ProposalDuration: time.Hour * 24 * 7,
 | 
						|
					TallyOption:      types.FirstPastThePost,
 | 
						|
				},
 | 
						|
			},
 | 
						|
		},
 | 
						|
		[]types.Proposal{
 | 
						|
			{ID: 1, CommitteeID: 1, PubProposal: gov.NewTextProposal("A Title", "A description of this proposal."), Deadline: testTime.Add(7 * 24 * time.Hour)},
 | 
						|
			{ID: 2, CommitteeID: 1, PubProposal: gov.NewTextProposal("Another Title", "A description of this other proposal."), Deadline: testTime.Add(21 * 24 * time.Hour)},
 | 
						|
		},
 | 
						|
		[]types.Vote{
 | 
						|
			{ProposalID: 1, Voter: suite.addresses[0], VoteType: types.Yes},
 | 
						|
			{ProposalID: 1, Voter: suite.addresses[1], VoteType: types.Yes},
 | 
						|
			{ProposalID: 2, Voter: suite.addresses[2], VoteType: types.Yes},
 | 
						|
		},
 | 
						|
	)
 | 
						|
	suite.app.InitializeFromGenesisStates(
 | 
						|
		NewCommitteeGenesisState(suite.cdc, suite.testGenesis),
 | 
						|
	)
 | 
						|
 | 
						|
	suite.votes = getProposalVoteMap(suite.keeper, suite.ctx)
 | 
						|
}
 | 
						|
 | 
						|
func (suite *QuerierTestSuite) TestQueryCommittees() {
 | 
						|
	ctx := suite.ctx.WithIsCheckTx(false)
 | 
						|
	// Set up request query
 | 
						|
	query := abci.RequestQuery{
 | 
						|
		Path: strings.Join([]string{custom, types.QuerierRoute, types.QueryCommittees}, "/"),
 | 
						|
	}
 | 
						|
 | 
						|
	// Execute query and check the []byte result
 | 
						|
	bz, err := suite.querier(ctx, []string{types.QueryCommittees}, query)
 | 
						|
	suite.NoError(err)
 | 
						|
	suite.NotNil(bz)
 | 
						|
 | 
						|
	// Unmarshal the bytes
 | 
						|
	var committees types.Committees
 | 
						|
	suite.NoError(suite.cdc.UnmarshalJSON(bz, &committees))
 | 
						|
 | 
						|
	// Check
 | 
						|
	suite.Equal(suite.testGenesis.Committees, committees)
 | 
						|
}
 | 
						|
 | 
						|
func (suite *QuerierTestSuite) TestQueryCommittee() {
 | 
						|
	ctx := suite.ctx.WithIsCheckTx(false)
 | 
						|
	// Set up request query
 | 
						|
	query := abci.RequestQuery{
 | 
						|
		Path: strings.Join([]string{custom, types.QuerierRoute, types.QueryCommittee}, "/"),
 | 
						|
		Data: suite.cdc.MustMarshalJSON(types.NewQueryCommitteeParams(suite.testGenesis.Committees[0].GetID())),
 | 
						|
	}
 | 
						|
 | 
						|
	// Execute query and check the []byte result
 | 
						|
	bz, err := suite.querier(ctx, []string{types.QueryCommittee}, query)
 | 
						|
	suite.NoError(err)
 | 
						|
	suite.NotNil(bz)
 | 
						|
 | 
						|
	// Unmarshal the bytes
 | 
						|
	var committee types.Committee
 | 
						|
	suite.NoError(suite.cdc.UnmarshalJSON(bz, &committee))
 | 
						|
 | 
						|
	// Check
 | 
						|
	suite.Equal(suite.testGenesis.Committees[0], committee)
 | 
						|
}
 | 
						|
 | 
						|
func (suite *QuerierTestSuite) TestQueryProposals() {
 | 
						|
	ctx := suite.ctx.WithIsCheckTx(false)
 | 
						|
	// Set up request query
 | 
						|
	comID := suite.testGenesis.Proposals[0].CommitteeID
 | 
						|
	query := abci.RequestQuery{
 | 
						|
		Path: strings.Join([]string{custom, types.QuerierRoute, types.QueryProposals}, "/"),
 | 
						|
		Data: suite.cdc.MustMarshalJSON(types.NewQueryCommitteeParams(comID)),
 | 
						|
	}
 | 
						|
 | 
						|
	// Execute query and check the []byte result
 | 
						|
	bz, err := suite.querier(ctx, []string{types.QueryProposals}, query)
 | 
						|
	suite.NoError(err)
 | 
						|
	suite.NotNil(bz)
 | 
						|
 | 
						|
	// Unmarshal the bytes
 | 
						|
	var proposals []types.Proposal
 | 
						|
	suite.NoError(suite.cdc.UnmarshalJSON(bz, &proposals))
 | 
						|
 | 
						|
	// Check
 | 
						|
	expectedProposals := []types.Proposal{}
 | 
						|
	for _, p := range suite.testGenesis.Proposals {
 | 
						|
		if p.CommitteeID == comID {
 | 
						|
			expectedProposals = append(expectedProposals, p)
 | 
						|
		}
 | 
						|
	}
 | 
						|
	suite.Equal(expectedProposals, proposals)
 | 
						|
}
 | 
						|
 | 
						|
func (suite *QuerierTestSuite) TestQueryProposal() {
 | 
						|
	ctx := suite.ctx.WithIsCheckTx(false)
 | 
						|
	// Set up request query
 | 
						|
	query := abci.RequestQuery{
 | 
						|
		Path: strings.Join([]string{custom, types.QuerierRoute, types.QueryProposal}, "/"),
 | 
						|
		Data: suite.cdc.MustMarshalJSON(types.NewQueryProposalParams(suite.testGenesis.Proposals[0].ID)),
 | 
						|
	}
 | 
						|
 | 
						|
	// Execute query and check the []byte result
 | 
						|
	bz, err := suite.querier(ctx, []string{types.QueryProposal}, query)
 | 
						|
	suite.NoError(err)
 | 
						|
	suite.NotNil(bz)
 | 
						|
 | 
						|
	// Unmarshal the bytes
 | 
						|
	var proposal types.Proposal
 | 
						|
	suite.NoError(suite.cdc.UnmarshalJSON(bz, &proposal))
 | 
						|
 | 
						|
	// Check
 | 
						|
	suite.Equal(suite.testGenesis.Proposals[0], proposal)
 | 
						|
}
 | 
						|
 | 
						|
func (suite *QuerierTestSuite) TestQueryNextProposalID() {
 | 
						|
	bz, err := suite.querier(suite.ctx, []string{types.QueryNextProposalID}, abci.RequestQuery{})
 | 
						|
	suite.Require().NoError(err)
 | 
						|
	suite.Require().NotNil(bz)
 | 
						|
 | 
						|
	var nextProposalID uint64
 | 
						|
	suite.Require().NoError(suite.cdc.UnmarshalJSON(bz, &nextProposalID))
 | 
						|
 | 
						|
	expectedID, _ := suite.keeper.GetNextProposalID(suite.ctx)
 | 
						|
	suite.Require().Equal(expectedID, nextProposalID)
 | 
						|
}
 | 
						|
 | 
						|
func (suite *QuerierTestSuite) TestQueryVotes() {
 | 
						|
	ctx := suite.ctx.WithIsCheckTx(false)
 | 
						|
	// Set up request query
 | 
						|
	propID := suite.testGenesis.Proposals[0].ID
 | 
						|
	query := abci.RequestQuery{
 | 
						|
		Path: strings.Join([]string{custom, types.QuerierRoute, types.QueryVotes}, "/"),
 | 
						|
		Data: suite.cdc.MustMarshalJSON(types.NewQueryProposalParams(propID)),
 | 
						|
	}
 | 
						|
 | 
						|
	// Execute query and check the []byte result
 | 
						|
	bz, err := suite.querier(ctx, []string{types.QueryVotes}, query)
 | 
						|
	suite.NoError(err)
 | 
						|
	suite.NotNil(bz)
 | 
						|
 | 
						|
	// Unmarshal the bytes
 | 
						|
	var votes []types.Vote
 | 
						|
	suite.NoError(suite.cdc.UnmarshalJSON(bz, &votes))
 | 
						|
 | 
						|
	// Check
 | 
						|
	suite.Equal(suite.votes[propID], votes)
 | 
						|
}
 | 
						|
 | 
						|
func (suite *QuerierTestSuite) TestQueryVote() {
 | 
						|
	ctx := suite.ctx.WithIsCheckTx(false)
 | 
						|
	// Set up request query
 | 
						|
	propID := suite.testGenesis.Proposals[0].ID
 | 
						|
	query := abci.RequestQuery{
 | 
						|
		Path: strings.Join([]string{custom, types.QuerierRoute, types.QueryVote}, "/"),
 | 
						|
		Data: suite.cdc.MustMarshalJSON(types.NewQueryVoteParams(propID, suite.votes[propID][0].Voter)),
 | 
						|
	}
 | 
						|
 | 
						|
	// Execute query and check the []byte result
 | 
						|
	bz, err := suite.querier(ctx, []string{types.QueryVote}, query)
 | 
						|
	suite.NoError(err)
 | 
						|
	suite.NotNil(bz)
 | 
						|
 | 
						|
	// Unmarshal the bytes
 | 
						|
	var vote types.Vote
 | 
						|
	suite.NoError(suite.cdc.UnmarshalJSON(bz, &vote))
 | 
						|
 | 
						|
	// Check
 | 
						|
	suite.Equal(suite.votes[propID][0], vote)
 | 
						|
}
 | 
						|
 | 
						|
func (suite *QuerierTestSuite) TestQueryTally() {
 | 
						|
 | 
						|
	ctx := suite.ctx.WithIsCheckTx(false)
 | 
						|
 | 
						|
	// Expected result
 | 
						|
	propID := suite.testGenesis.Proposals[0].ID
 | 
						|
	expectedPollingStatus := types.ProposalPollingStatus{
 | 
						|
		ProposalID:    1,
 | 
						|
		YesVotes:      sdk.NewDec(int64(len(suite.votes[propID]))),
 | 
						|
		CurrentVotes:  sdk.NewDec(int64(len(suite.votes[propID]))),
 | 
						|
		PossibleVotes: d("3.0"),
 | 
						|
		VoteThreshold: d("0.667"),
 | 
						|
		Quorum:        d("0"),
 | 
						|
	}
 | 
						|
 | 
						|
	// Set up request query
 | 
						|
	query := abci.RequestQuery{
 | 
						|
		Path: strings.Join([]string{custom, types.QuerierRoute, types.QueryTally}, "/"),
 | 
						|
		Data: suite.cdc.MustMarshalJSON(types.NewQueryProposalParams(propID)),
 | 
						|
	}
 | 
						|
 | 
						|
	// Execute query and check the []byte result
 | 
						|
	bz, err := suite.querier(ctx, []string{types.QueryTally}, query)
 | 
						|
	suite.NoError(err)
 | 
						|
	suite.NotNil(bz)
 | 
						|
 | 
						|
	// Unmarshal the bytes
 | 
						|
	var propPollingStatus types.ProposalPollingStatus
 | 
						|
	suite.NoError(suite.cdc.UnmarshalJSON(bz, &propPollingStatus))
 | 
						|
	suite.Equal(expectedPollingStatus, propPollingStatus)
 | 
						|
}
 | 
						|
 | 
						|
type TestSubParam struct {
 | 
						|
	Some   string
 | 
						|
	Test   sdk.Dec
 | 
						|
	Params []types.Vote
 | 
						|
}
 | 
						|
type TestParams struct {
 | 
						|
	TestKey TestSubParam
 | 
						|
}
 | 
						|
 | 
						|
const paramKey = "TestKey"
 | 
						|
 | 
						|
func (p *TestParams) ParamSetPairs() params.ParamSetPairs {
 | 
						|
	return params.ParamSetPairs{
 | 
						|
		params.NewParamSetPair([]byte(paramKey), &p.TestKey, func(interface{}) error { return nil }),
 | 
						|
	}
 | 
						|
}
 | 
						|
func (suite *QuerierTestSuite) TestQueryRawParams() {
 | 
						|
	ctx := suite.ctx.WithIsCheckTx(false)
 | 
						|
 | 
						|
	// Create a new param subspace to avoid adding dependency to another module. Set a test param value.
 | 
						|
	subspaceName := "test"
 | 
						|
	subspace := suite.app.GetParamsKeeper().Subspace(subspaceName)
 | 
						|
	subspace = subspace.WithKeyTable(params.NewKeyTable().RegisterParamSet(&TestParams{}))
 | 
						|
 | 
						|
	paramValue := TestSubParam{
 | 
						|
		Some: "test",
 | 
						|
		Test: d("1000000000000.000000000000000001"),
 | 
						|
		Params: []types.Vote{
 | 
						|
			types.NewVote(1, suite.addresses[0], types.Yes),
 | 
						|
			types.NewVote(12, suite.addresses[1], types.Yes),
 | 
						|
		},
 | 
						|
	}
 | 
						|
	subspace.Set(ctx, []byte(paramKey), paramValue)
 | 
						|
 | 
						|
	// Set up request query
 | 
						|
	query := abci.RequestQuery{
 | 
						|
		Path: strings.Join([]string{custom, types.QuerierRoute, types.QueryRawParams}, "/"),
 | 
						|
		Data: suite.cdc.MustMarshalJSON(types.NewQueryRawParamsParams(subspaceName, paramKey)),
 | 
						|
	}
 | 
						|
 | 
						|
	// Execute query
 | 
						|
	bz, err := suite.querier(ctx, []string{types.QueryRawParams}, query)
 | 
						|
	suite.NoError(err)
 | 
						|
	suite.NotNil(bz)
 | 
						|
 | 
						|
	// Unmarshal the bytes
 | 
						|
	var returnedParamValue []byte
 | 
						|
	suite.NoError(suite.cdc.UnmarshalJSON(bz, &returnedParamValue))
 | 
						|
 | 
						|
	// Check
 | 
						|
	suite.Equal(suite.cdc.MustMarshalJSON(paramValue), returnedParamValue)
 | 
						|
}
 | 
						|
 | 
						|
func TestQuerierTestSuite(t *testing.T) {
 | 
						|
	suite.Run(t, new(QuerierTestSuite))
 | 
						|
}
 |