lcd

Documentation

Index

• func ServeCommand(cdc *codec.Codec, registerRoutesFn func(*RestServer)) *cobra.Command
• type RestServer
  • func NewRestServer(cdc *codec.Codec) *RestServer
  • func (rs *RestServer) RegisterSwaggerUI()
  • func (rs *RestServer) Start(listenAddr string, maxOpen int, readTimeout, writeTimeout uint) (err 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
	KeyBase keybase.Keybase
	// 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) RegisterSwaggerUI

func (rs *RestServer) RegisterSwaggerUI()

func (*RestServer) Start

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

Start starts the rest server