rest

Documentation

Index

• Constants
• func BroadcastTxRequest(cliCtx context.CLIContext) http.HandlerFunc
• func DecodeTxRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc
• func EncodeTxRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc
• func QueryAccountRequestHandlerFn(storeName string, cliCtx context.CLIContext) http.HandlerFunc
• func QueryTxRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc
• func QueryTxsRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc
• func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router, storeName string)
• func RegisterTxRoutes(cliCtx context.CLIContext, r *mux.Router)
• type BroadcastReq
• type DecodeReq
• type DecodeResp
• type EncodeResp

Constants

const (
	MethodGet = "GET"
)

REST query and parameter values

Functions

func BroadcastTxRequest

func BroadcastTxRequest(cliCtx context.CLIContext) http.HandlerFunc

BroadcastTxRequest implements a tx broadcasting handler that is responsible for broadcasting a valid and signed tx to a full node. The tx can be broadcasted via a sync|async|block mechanism.

func DecodeTxRequestHandlerFn

func DecodeTxRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc

DecodeTxRequestHandlerFn returns the decode tx REST handler. In particular, it takes base64-decoded bytes, decodes it from the Amino wire protocol, and responds with a json-formatted transaction.

func EncodeTxRequestHandlerFn

func EncodeTxRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc

EncodeTxRequestHandlerFn returns the encode tx REST handler. In particular, it takes a json-formatted transaction, encodes it to the Amino wire protocol, and responds with base64-encoded bytes.

func QueryAccountRequestHandlerFn

func QueryAccountRequestHandlerFn(storeName string, cliCtx context.CLIContext) http.HandlerFunc

query accountREST Handler

func QueryTxRequestHandlerFn

func QueryTxRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc

QueryTxRequestHandlerFn implements a REST handler that queries a transaction by hash in a committed block.

func QueryTxsRequestHandlerFn

func QueryTxsRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc

QueryTxsHandlerFn implements a REST handler that searches for transactions. Genesis transactions are returned if the height parameter is set to zero, otherwise the transactions are searched for by events.

func RegisterRoutes

func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router, storeName string)

RegisterRoutes registers the auth module REST routes.

func RegisterTxRoutes

func RegisterTxRoutes(cliCtx context.CLIContext, r *mux.Router)

RegisterTxRoutes registers all transaction routes on the provided router.

Types

type BroadcastReq

type BroadcastReq struct {
	Tx   types.StdTx `json:"tx" yaml:"tx"`
	Mode string      `json:"mode" yaml:"mode"`
}

BroadcastReq defines a tx broadcasting request.

type DecodeReq

type DecodeReq struct {
	Tx string `json:"tx"`
}

DecodeReq defines a tx decoding request.

type DecodeResp

type DecodeResp authtypes.StdTx

DecodeResp defines a tx decoding response.

type EncodeResp

type EncodeResp struct {
	Tx string `json:"tx" yaml:"tx"`
}

EncodeResp defines a tx encoding response.