api

Documentation

Index

• type Server
  • func New(clientCtx client.Context, logger log.Logger) *Server
  • func (s *Server) Close() error
  • func (s *Server) Start(cfg config.Config) error

Types

type Server

type Server struct {
	Router    *mux.Router
	ClientCtx client.Context
	// contains filtered or unexported fields
}

Server defines the server's API interface.

func New

func New(clientCtx client.Context, logger log.Logger) *Server

func (*Server) Close

func (s *Server) Close() error

Close closes the API server.

func (*Server) Start

func (s *Server) Start(cfg config.Config) error

Start starts the API server. Internally, the API server leverages Tendermint's JSON RPC server. Configuration options are provided via config.APIConfig and are delegated to the Tendermint JSON RPC server. The process is non-blocking, so an external signal handler must be used.