types

type DeductOption byte

type Deposit struct {
	Depositor  types.Address `json:"depositor"`   //  Address of the depositor
	ProposalID uint64        `json:"proposal_id"` //  proposalID of the proposal
	Amount     uint64        `json:"amount"`      //  Deposit amount
}

type Deposits []Deposit

type GenesisProposal struct {
	Proposal Proposal  `json:"proposal"`
	Deposits []Deposit `json:"deposits"`
	Votes    []Vote    `json:"votes"`
}

type GenesisState struct {
	StartingProposalID uint64            `json:"starting_proposal_id"`
	Params             Params            `json:"params"`
	Proposals          []GenesisProposal `json:"proposals"`
}

type ModifyInflationProposal struct {
	TextProposal
	TotalAmount      uint64                `json:"total_amount"`
	InflationPhrases mint.InflationPhrases `json:"inflation_phrases"`
}

type Param struct {
	Module string `json:"module"`
	Key    string `json:"key"`
	Value  string `json:"value"`
}

type ParameterProposal struct {
	TextProposal
	Params []Param `json:"params"`
}

type Params struct {
	// DepositParams
	MinDeposit             uint64        `json:"min_deposit"`               //  Minimum deposit for a proposal to enter voting period.
	MinProposerDepositRate qtypes.Dec    `json:"min_proposer_deposit_rate"` //  Minimum deposit rate for proposer to submit a proposal. Initial value: 1/3
	MaxDepositPeriod       time.Duration `json:"max_deposit_period"`        //  Maximum period for Atom holders to deposit on a proposal. Initial value: 2 months

	// VotingParams
	VotingPeriod time.Duration `json:"voting_period"` //  Length of the voting period.

	// TallyParams
	Quorum    qtypes.Dec `json:"quorum"`    //  Minimum percentage of total stake needed to vote for a result to be considered valid
	Threshold qtypes.Dec `json:"threshold"` //  Minimum propotion of Yes votes for proposal to pass. Initial value: 0.5
	Veto      qtypes.Dec `json:"veto"`      //  Minimum value of Veto votes to Total votes ratio for proposal to be vetoed. Initial value: 1/3
	Penalty   qtypes.Dec `json:"penalty"`   //  Penalty if validator does not vote

	BurnRate qtypes.Dec `json:"burn_rate"` // Deposit burning rate when proposals pass or reject. Initial value: 1/2
}

type Proposal struct {
	ProposalContent `json:"proposal_content"` // Proposal content interface

	ProposalID uint64 `json:"proposal_id"` //  ID of the proposal

	Status           ProposalStatus `json:"proposal_status"`    //  Status of the Proposal {Pending, Active, Passed, Rejected}
	FinalTallyResult TallyResult    `json:"final_tally_result"` //  Result of Tallys

	SubmitTime     time.Time `json:"submit_time"`      //  Time of the block where TxGovSubmitProposal was included
	DepositEndTime time.Time `json:"deposit_end_time"` // Time that the Proposal would expire if deposit amount isn't met
	TotalDeposit   uint64    `json:"total_deposit"`    //  Current deposit on this proposal. Initial value is set at InitialDeposit

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

type ProposalContent interface {
	GetTitle() string
	GetDescription() string
	GetDeposit() uint64
	GetProposalType() ProposalType
}

type ProposalResult string

type ProposalStatus byte

type ProposalType byte

type SoftwareUpgradeProposal struct {
	TextProposal
	Version       string `json:"version"`
	DataHeight    uint64 `json:"data_height"`
	GenesisFile   string `json:"genesis_file"`
	GenesisMD5    string `json:"genesis_md5"`
	ForZeroHeight bool   `json:"for_zero_height"`
}

type TallyResult struct {
	Yes        int64 `json:"yes"`
	Abstain    int64 `json:"abstain"`
	No         int64 `json:"no"`
	NoWithVeto int64 `json:"no_with_veto"`
}

type TaxUsageProposal struct {
	TextProposal
	DestAddress btypes.Address `json:"dest_address"`
	Percent     types.Dec      `json:"percent"`
}

type TextProposal struct {
	Title       string `json:"title"`       //  Title of the proposal
	Description string `json:"description"` //  Description of the proposal
	Deposit     uint64 `json:"deposit"`     //	Deposit of the proposal
}

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

type VoteOption byte

type Votes []Vote