rest

Documentation

Index

• Constants
• func CheckBadRequestError(w http.ResponseWriter, err error) bool
• func CheckError(w http.ResponseWriter, status int, err error) bool
• func CheckInternalServerError(w http.ResponseWriter, err error) bool
• func ParseQueryHeightOrReturnBadRequest(w http.ResponseWriter, clientCtx client.Context, r *http.Request) (client.Context, bool)
• func PostProcessResponse(w http.ResponseWriter, ctx client.Context, resp interface{})
• func RegisterRoutes(clientCtx client.Context, rtr *mux.Router)
• func WithHTTPDeprecationHeaders(r *mux.Router) *mux.Router
• func WriteErrorResponse(w http.ResponseWriter, status int, err string)
• type ErrorResponse
  • func NewErrorResponse(code int, err string) ErrorResponse
• type ResponseWithHeight
  • func NewResponseWithHeight(height int64, result json.RawMessage) ResponseWithHeight

Constants

const DeprecationURL = "https://docs.cosmos.network/master/migrations/rest.html"

DeprecationURL is the URL for migrating deprecated REST endpoints to newer ones. TODO Switch to `/` (not `/master`) once v0.40 docs are deployed. https://github.com/cosmos/cosmos-sdk/issues/8019

Functions

func CheckBadRequestError

func CheckBadRequestError(w http.ResponseWriter, err error) bool

CheckBadRequestError attaches an error message to an HTTP 400 BAD REQUEST response. Returns false when err is nil; it returns true otherwise.

func CheckError

func CheckError(w http.ResponseWriter, status int, err error) bool

CheckError takes care of writing an error response if err is not nil. Returns false when err is nil; it returns true otherwise.

func CheckInternalServerError

func CheckInternalServerError(w http.ResponseWriter, err error) bool

CheckInternalServerError attaches an error message to an HTTP 500 INTERNAL SERVER ERROR response. Returns false when err is nil; it returns true otherwise.

func ParseQueryHeightOrReturnBadRequest

func ParseQueryHeightOrReturnBadRequest(w http.ResponseWriter, clientCtx client.Context, r *http.Request) (client.Context, bool)

ParseQueryHeightOrReturnBadRequest sets the height to execute a query if set by the http request. It returns false if there was an error parsing the height.

func PostProcessResponse

func PostProcessResponse(w http.ResponseWriter, ctx client.Context, resp interface{})

PostProcessResponse performs post processing for a REST response. The result returned to clients will contain two fields, the height at which the resource was queried at and the original result.

func RegisterRoutes

func RegisterRoutes(clientCtx client.Context, rtr *mux.Router)

RegisterRoutes registers minting module REST handlers on the provided router.

func WithHTTPDeprecationHeaders

func WithHTTPDeprecationHeaders(r *mux.Router) *mux.Router

func WriteErrorResponse

func WriteErrorResponse(w http.ResponseWriter, status int, err string)

WriteErrorResponse prepares and writes a HTTP error given a status code and an error message.

Types

type ErrorResponse

type ErrorResponse struct {
	Code  int    `json:"code,omitempty"`
	Error string `json:"error"`
}

ErrorResponse defines the attributes of a JSON error response.

func NewErrorResponse

func NewErrorResponse(code int, err string) ErrorResponse

NewErrorResponse creates a new ErrorResponse instance.

type ResponseWithHeight

type ResponseWithHeight struct {
	Height int64           `json:"height"`
	Result json.RawMessage `json:"result"`
}

ResponseWithHeight defines a response object type that wraps an original response with a height.

func NewResponseWithHeight

func NewResponseWithHeight(height int64, result json.RawMessage) ResponseWithHeight

NewResponseWithHeight creates a new ResponseWithHeight instance