rest

Documentation

Overview

Package rest defines the RESTful service for the gov module.

Index

• Constants
• func RegisterRoutes(cliCtx client.Context, r *mux.Router, phs []govRest.ProposalRESTHandler)
• type ProposalRESTHandler
• type VoteWithPower
• type VotesWithPower

Constants

const (
	RestParamsType     = "type"
	RestProposalID     = "proposal-id"
	RestDepositor      = "depositor"
	RestVoter          = "voter"
	RestProposalStatus = "status"
)

REST Variable names

Functions

func RegisterRoutes

func RegisterRoutes(cliCtx client.Context, r *mux.Router, phs []govRest.ProposalRESTHandler)

RegisterRoutes is the central function to define routes that get registered by the main application.

Types

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 VoteWithPower

type VoteWithPower struct {
	govtypes.Vote
	VotingPower sdk.Dec `json:"voting_power" yaml:"voting_power"`
}

type VotesWithPower

type VotesWithPower []VoteWithPower