mirror of
				https://github.com/0glabs/0g-chain.git
				synced 2025-11-04 11: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>
		
			
				
	
	
		
			147 lines
		
	
	
		
			4.8 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			147 lines
		
	
	
		
			4.8 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
package simulation
 | 
						|
 | 
						|
import (
 | 
						|
	"fmt"
 | 
						|
	"math/rand"
 | 
						|
	"strings"
 | 
						|
	"time"
 | 
						|
 | 
						|
	"github.com/cosmos/cosmos-sdk/codec"
 | 
						|
	sdk "github.com/cosmos/cosmos-sdk/types"
 | 
						|
	"github.com/cosmos/cosmos-sdk/types/module"
 | 
						|
	"github.com/cosmos/cosmos-sdk/x/simulation"
 | 
						|
 | 
						|
	"github.com/kava-labs/kava/x/committee/types"
 | 
						|
)
 | 
						|
 | 
						|
const (
 | 
						|
	// Block time params are un-exported constants in cosmos-sdk/x/simulation.
 | 
						|
	// Copy them here in lieu of importing them.
 | 
						|
	minTimePerBlock time.Duration = (10000 / 2) * time.Second
 | 
						|
	maxTimePerBlock time.Duration = 10000 * time.Second
 | 
						|
	// Calculate the average block time
 | 
						|
	AverageBlockTime time.Duration = (maxTimePerBlock - minTimePerBlock) / 2
 | 
						|
 | 
						|
	FallbackCommitteeID uint64 = 0
 | 
						|
)
 | 
						|
 | 
						|
// RandomizedGenState generates a random GenesisState for the module
 | 
						|
func RandomizedGenState(simState *module.SimulationState) {
 | 
						|
	r := simState.Rand
 | 
						|
 | 
						|
	// Create an always present committee with god permissions to ensure any randomly generated proposal can always be submitted.
 | 
						|
	// Without this, proposals can often not be submitted as there aren't any committees with the right set of permissions available.
 | 
						|
	// It provides more control over how often different proposal types happen during simulation.
 | 
						|
	// It also makes the code simpler--proposals can just be randomly generated and submitted without having to comply to permissions that happen to be available at the time.
 | 
						|
	fallbackCommittee := types.NewMemberCommittee(
 | 
						|
		FallbackCommitteeID,
 | 
						|
		"A committee with god permissions that will always be in state and not deleted. It ensures any generated proposal can always be submitted and passed.",
 | 
						|
		RandomAddresses(r, simState.Accounts),
 | 
						|
		[]types.Permission{types.GodPermission{}},
 | 
						|
		sdk.MustNewDecFromStr("0.5"),
 | 
						|
		AverageBlockTime*10,
 | 
						|
		types.FirstPastThePost,
 | 
						|
	)
 | 
						|
 | 
						|
	// Create other committees
 | 
						|
	numCommittees := r.Intn(100)
 | 
						|
	committees := []types.Committee{fallbackCommittee}
 | 
						|
	for i := 0; i < numCommittees; i++ {
 | 
						|
		com, err := RandomCommittee(r, firstNAccounts(25, simState.Accounts), paramChangeToAllowedParams(simState.ParamChanges))
 | 
						|
		if err != nil {
 | 
						|
			panic(err)
 | 
						|
		}
 | 
						|
		committees = append(committees, com)
 | 
						|
	}
 | 
						|
 | 
						|
	// Add genesis state to simState
 | 
						|
	genesisState := types.NewGenesisState(
 | 
						|
		types.DefaultNextProposalID,
 | 
						|
		committees,
 | 
						|
		[]types.Proposal{},
 | 
						|
		[]types.Vote{},
 | 
						|
	)
 | 
						|
	fmt.Printf("Selected randomly generated %s parameters:\n%s\n", types.ModuleName, codec.MustMarshalJSONIndent(simState.Cdc, genesisState))
 | 
						|
	simState.GenState[types.ModuleName] = simState.Cdc.MustMarshalJSON(genesisState)
 | 
						|
}
 | 
						|
 | 
						|
func RandomCommittee(r *rand.Rand, availableAccs []simulation.Account, allowedParams []types.AllowedParam) (types.Committee, error) {
 | 
						|
	// pick committee members
 | 
						|
	if len(availableAccs) < 1 {
 | 
						|
		return types.MemberCommittee{}, fmt.Errorf("must be ≥ 1 addresses")
 | 
						|
	}
 | 
						|
	var members []sdk.AccAddress
 | 
						|
	for len(members) < 1 {
 | 
						|
		members = RandomAddresses(r, availableAccs)
 | 
						|
	}
 | 
						|
 | 
						|
	// pick proposal duration
 | 
						|
	dur, err := RandomPositiveDuration(r, 0, AverageBlockTime*10)
 | 
						|
	if err != nil {
 | 
						|
		return types.MemberCommittee{}, err
 | 
						|
	}
 | 
						|
 | 
						|
	// pick committee vote threshold, must be in interval (0,1]
 | 
						|
	threshold := simulation.RandomDecAmount(r, sdk.MustNewDecFromStr("1").Sub(sdk.SmallestDec())).Add(sdk.SmallestDec())
 | 
						|
 | 
						|
	var committee types.Committee
 | 
						|
	if r.Uint64()%2 == 0 {
 | 
						|
		committee = types.NewMemberCommittee(
 | 
						|
			r.Uint64(), // could collide with other committees, but unlikely
 | 
						|
			simulation.RandStringOfLength(r, r.Intn(types.MaxCommitteeDescriptionLength+1)),
 | 
						|
			members,
 | 
						|
			RandomPermissions(r, allowedParams),
 | 
						|
			threshold,
 | 
						|
			dur,
 | 
						|
			types.FirstPastThePost,
 | 
						|
		)
 | 
						|
	} else {
 | 
						|
		tallyDenom := strings.ToLower(simulation.RandStringOfLength(r, (r.Intn(3) + 3)))
 | 
						|
 | 
						|
		committee = types.NewTokenCommittee(
 | 
						|
			r.Uint64(), // could collide with other committees, but unlikely
 | 
						|
			simulation.RandStringOfLength(r, r.Intn(types.MaxCommitteeDescriptionLength+1)),
 | 
						|
			members,
 | 
						|
			RandomPermissions(r, allowedParams),
 | 
						|
			threshold,
 | 
						|
			dur,
 | 
						|
			types.FirstPastThePost,
 | 
						|
			sdk.MustNewDecFromStr("0.25"),
 | 
						|
			tallyDenom,
 | 
						|
		)
 | 
						|
	}
 | 
						|
 | 
						|
	return committee, nil
 | 
						|
}
 | 
						|
 | 
						|
func RandomPermissions(r *rand.Rand, allowedParams []types.AllowedParam) []types.Permission {
 | 
						|
	var permissions []types.Permission
 | 
						|
	if r.Intn(100) < 50 {
 | 
						|
		permissions = append(permissions, types.TextPermission{})
 | 
						|
	}
 | 
						|
	if r.Intn(100) < 50 {
 | 
						|
		r.Shuffle(len(allowedParams), func(i, j int) {
 | 
						|
			allowedParams[i], allowedParams[j] = allowedParams[j], allowedParams[i]
 | 
						|
		})
 | 
						|
		permissions = append(permissions,
 | 
						|
			types.SimpleParamChangePermission{
 | 
						|
				AllowedParams: allowedParams[:r.Intn(len(allowedParams)+1)],
 | 
						|
			})
 | 
						|
	}
 | 
						|
	return permissions
 | 
						|
}
 | 
						|
 | 
						|
func paramChangeToAllowedParams(paramChanges []simulation.ParamChange) []types.AllowedParam {
 | 
						|
	var allowedParams []types.AllowedParam
 | 
						|
	for _, pc := range paramChanges {
 | 
						|
		allowedParams = append(
 | 
						|
			allowedParams,
 | 
						|
			types.AllowedParam{
 | 
						|
				Subspace: pc.Subspace,
 | 
						|
				Key:      pc.Key,
 | 
						|
			},
 | 
						|
		)
 | 
						|
	}
 | 
						|
	return allowedParams
 | 
						|
}
 |