Documentation
¶
Overview ¶
nolint
Index ¶
Constants ¶
View Source
const ( RestParamsType = "type" RestProposalID = "proposal-id" RestDepositor = "depositor" RestVoter = "voter" RestProposalStatus = "status" RestNumLimit = "limit" )
REST Variable names nolint
Variables ¶
This section is empty.
Functions ¶
func RegisterRoutes ¶
func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router, phs []ProposalRESTHandler)
RegisterRoutes - Central function to define routes that get registered by the main application
Types ¶
type DepositQuery ¶
type DepositReq ¶
type DepositReq struct {
BaseReq rest.BaseReq `json:"base_req" yaml:"base_req"`
Depositor hmTypes.IrisAddress `json:"depositor" yaml:"depositor"` // Address of the depositor
Amount sdk.Coins `json:"amount" yaml:"amount"` // Coins to add to the proposal's deposit
Validator hmTypes.ValidatorID `json:"validator" yaml:"validator"` // id of the validator
}
DepositReq defines the properties of a deposit request's body.
type PostProposalReq ¶
type PostProposalReq struct {
BaseReq rest.BaseReq `json:"base_req" yaml:"base_req"`
Title string `json:"title" yaml:"title"` // Title of the proposal
Description string `json:"description" yaml:"description"` // Description of the proposal
ProposalType string `json:"proposal_type" yaml:"proposal_type"` // Type of proposal. Initial set {PlainTextProposal, SoftwareUpgradeProposal}
Proposer hmTypes.IrisAddress `json:"proposer" yaml:"proposer"` // Address of the proposer
Validator hmTypes.ValidatorID `json:"validator" yaml:"validator"` // id of the validator
InitialDeposit sdk.Coins `json:"initial_deposit" yaml:"initial_deposit"` // Coins to add to the proposal's deposit
}
PostProposalReq defines the properties of a proposal request's body.
type ProposalId ¶
type ProposalId struct {
//Proposal ID
//in:path
ProposalId int64 `json:"proposal-id"`
}
type ProposalRESTHandler ¶
type ProposalRESTHandler struct {
SubRoute string
Handler func(http.ResponseWriter, *http.Request)
}
ProposalRESTHandler defines a REST handler implemented in another module. The sub-route is mounted on the governance REST handler.
type ProposalsQuery ¶
type TallyResult ¶
type VoteReq ¶
type VoteReq struct {
BaseReq rest.BaseReq `json:"base_req" yaml:"base_req"`
Voter hmTypes.IrisAddress `json:"voter" yaml:"voter"` // address of the voter
Option string `json:"option" yaml:"option"` // option from OptionSet chosen by the voter
Validator hmTypes.ValidatorID `json:"validator" yaml:"validator"` // id of the validator
}
VoteReq defines the properties of a vote request's body.
type VotesQuery ¶
Click to show internal directories.
Click to hide internal directories.