types

type AccountKeeper interface {
	GetAccount(ctx sdk.Context, addr sdk.AccAddress) authexported.Account
}

type CodeType = uint32

type Content struct {
	Title       string `json:"title" yaml:"title"`             // Proposal title
	Description string `json:"description" yaml:"description"` // Proposal description
}

type GenesisState struct {
	StartingProposalID uint64      `json:"starting_proposal_id" yaml:"starting_proposal_id"`
	Votes              Votes       `json:"votes" yaml:"votes"`
	Proposals          Proposals   `json:"proposals" yaml:"proposals"`
	TallyParams        TallyParams `json:"tally_params" yaml:"tally_params"`
}

type Handler func(ctx sdk.Context, content Content) error

type MsgSoftwareUpgradeProposal struct {
	Title       string         `json:"title" yaml:"title"`
	Description string         `json:"description" yaml:"description"`
	Plan        Plan           `json:"plan" yaml:"plan"`
	Proposer    sdk.AccAddress `json:"proposer" yaml:"proposer"` //  Address of the proposer
}

type MsgSubmitProposal struct {
	Content          Content        `json:"content" yaml:"content"`
	Proposer         sdk.AccAddress `json:"proposer" yaml:"proposer"` //  Address of the proposer
	VotingStartBlock uint64         `json:"voting_start_block" yaml:"voting_start_block"`
	VotingEndBlock   uint64         `json:"voting_end_block" yaml:"voting_end_block"`
}

type MsgVote struct {
	ProposalID uint64         `json:"proposal_id" yaml:"proposal_id"` // ID of the proposal
	Voter      sdk.ValAddress `json:"voter" yaml:"voter"`             //  address of the voter
	Option     VoteOption     `json:"option" yaml:"option"`           //  option from OptionSet chosen by the voter
}

type ParamSubspace interface {
	Get(ctx sdk.Context, key []byte, ptr interface{})
	Set(ctx sdk.Context, key []byte, param interface{})
}

type Params struct {
	TallyParams TallyParams `json:"tally_params" yaml:"tally_params"`
}

type Plan struct {
	// Sets the name for the upgrade. This name will be used by the upgraded version of the software to apply any
	// special "on-upgrade" commands during the first BeginBlock method after the upgrade is applied. It is also used
	// to detect whether a software version can handle a given upgrade. If no upgrade handler with this name has been
	// set in the software, it will be assumed that the software is out-of-date when the upgrade Time or Height
	// is reached and the software will exit.
	Name string `json:"name,omitempty"`

	// The time after which the upgrade must be performed.
	// Leave set to its zero value to use a pre-defined Height instead.
	Time time.Time `json:"time,omitempty"`

	// The height at which the upgrade must be performed.
	// Only used if Time is not set.
	Height int64 `json:"height,omitempty"`

	// Any application specific upgrade info to be included on-chain
	// such as a git commit that validators could automatically upgrade to
	Info string `json:"info,omitempty"`

	ToDownload int64 `json:"to_update,omitempty"`
}

type Proposal struct {
	Content

	ProposalID       uint64         `json:"id" yaml:"id"`                                 //  ID of the proposal
	Status           ProposalStatus `json:"proposal_status" yaml:"proposal_status"`       // Status of the Proposal {Pending, Active, Passed, Rejected}
	FinalTallyResult TallyResult    `json:"final_tally_result" yaml:"final_tally_result"` // Result of Tallys

	VotingStartBlock uint64 `json:"voting_start_time" yaml:"voting_start_time"` // Time of the block where MinDeposit was reached. -1 if MinDeposit is not reached
	VotingEndBlock   uint64 `json:"voting_end_time" yaml:"voting_end_time"`     // Time that the VotingPeriod for this proposal will end and votes will be tallied
}

type ProposalQueue []uint64

type ProposalStatus byte

type Proposals []Proposal

type QueryDepositParams struct {
	ProposalID uint64
	Depositor  sdk.AccAddress
}

type QueryProposalParams struct {
	ProposalID uint64
}

type QueryProposalVotesParams struct {
	ProposalID uint64
	Page       int
	Limit      int
}

type QueryProposalsParams struct {
	Page           int
	Limit          int
	Voter          sdk.AccAddress
	Depositor      sdk.AccAddress
	ProposalStatus ProposalStatus
}

type QueryVoteParams struct {
	ProposalID uint64
	Voter      sdk.AccAddress
}

type Router interface {
	AddRoute(r string, h Handler) (rtr Router)
	HasRoute(r string) bool
	GetRoute(path string) (h Handler)
	Seal()
}

type SupplyKeeper interface {
	GetModuleAddress(name string) sdk.AccAddress
	GetModuleAccount(ctx sdk.Context, name string) supplyexported.ModuleAccountI

	// TODO remove with genesis 2-phases refactor https://github.com/cosmos/cosmos-sdk/issues/2862
	SetModuleAccount(sdk.Context, supplyexported.ModuleAccountI)

	SendCoinsFromModuleToAccount(ctx sdk.Context, senderModule string, recipientAddr sdk.AccAddress, amt sdk.Coins) error
	SendCoinsFromAccountToModule(ctx sdk.Context, senderAddr sdk.AccAddress, recipientModule string, amt sdk.Coins) error
	BurnCoins(ctx sdk.Context, name string, amt sdk.Coins) error
}

type TallyParams struct {
	Quorum    sdk.Dec `json:"quorum,omitempty" yaml:"quorum,omitempty"`       //  Minimum percentage of total stake needed to vote for a result to be considered valid
	Threshold sdk.Dec `json:"threshold,omitempty" yaml:"threshold,omitempty"` //  Minimum proportion of Yes votes for proposal to pass. Initial value: 0.5
}

type TallyResult struct {
	Yes     sdk.Int `json:"yes" yaml:"yes"`
	Abstain sdk.Int `json:"abstain" yaml:"abstain"`
	No      sdk.Int `json:"no" yaml:"no"`
}

type UpgradeConfig struct {
	Binaries map[string]string `json:"binaries"`
}

type ValidatorGovInfo struct {
	Address      sdk.ValAddress // address of the validator operator
	BondedTokens sdk.Int        // Power of a Validator
	Vote         VoteOption     // Vote of the validator
}

type ValidatorKeeper interface {
	// iterate through bonded validators by operator address, execute func for each validator
	IterateBondedValidatorsByPower(
		sdk.Context, func(index int64, validator valexported.ValidatorI) (stop bool),
	)

	TotalBondedTokens(sdk.Context) sdk.Int // total bonded tokens within the validator set
	IterateDelegations(
		ctx sdk.Context, delegator sdk.AccAddress,
		fn func(index int64, delegation valexported.DelegationI) (stop bool),
	)

	HasValidator(sdk.Context, sdk.ValAddress) bool
}

type Vote struct {
	ProposalID uint64         `json:"proposal_id" yaml:"proposal_id"` //  proposalID of the proposal
	Voter      sdk.ValAddress `json:"voter" yaml:"voter"`             //  address of the voter
	Option     VoteOption     `json:"option" yaml:"option"`           //  option from OptionSet chosen by the voter
}

type VoteOption byte

type Votes []Vote