lcd

Documentation

Index

• func ServeCommand(cdc *codec.Codec, registerRoutesFn func(*RestServer)) *cobra.Command
• type RestServer
  • func NewRestServer(cdc *codec.Codec) *RestServer
  • func (rs *RestServer) Start(listenAddr string, maxOpen int, readTimeout, writeTimeout uint, cors bool) error
  • func (rs *RestServer) StartWithConfig(listenAddr string, cors bool, cfg *rpcserver.Config) error

Functions

func ServeCommand

func ServeCommand(cdc *codec.Codec, registerRoutesFn func(*RestServer)) *cobra.Command

ServeCommand will start the application REST service as a blocking process. It takes a codec to create a RestServer object and a function to register all necessary routes.

Types

type RestServer

type RestServer struct {
	Mux    *mux.Router
	CliCtx context.CLIContext
	// contains filtered or unexported fields
}

RestServer represents the Light Client Rest server

func NewRestServer

func NewRestServer(cdc *codec.Codec) *RestServer

NewRestServer creates a new rest server instance

func (*RestServer) Start

func (rs *RestServer) Start(listenAddr string, maxOpen int, readTimeout, writeTimeout uint, cors bool) error

Start starts the REST server that listens on the provided listenAddr. The REST service will use Tendermint's default RPC configuration, where the R/W timeout and max open connections are overridden.

func (*RestServer) StartWithConfig

func (rs *RestServer) StartWithConfig(listenAddr string, cors bool, cfg *rpcserver.Config) error

StartWithConfig starts the REST server that listens on the provided listenAddr. It will use the provided RPC configuration.