grpc

README

gRPC

This directory contains required files for gRPC service.

In order to compile pactus.proto file, run this command:

make proto

gRPC-gateway

Pactus utilizes the gRPC-gateway to transform gRPC services into RESTful APIs, accompanied by a Swagger UI.

Documentation

Index

• type Config
  • func DefaultConfig() *Config
• type GatewayConfig
• type Server
  • func NewServer(conf *Config, st state.Facade, syn sync.Synchronizer, n network.Network, ...) *Server
  • func (s *Server) Address() string
  • func (s *Server) StartServer() error
  • func (s *Server) StopServer()

Types

type Config

type Config struct {
	Enable  bool          `toml:"enable"`
	Listen  string        `toml:"listen"`
	Gateway GatewayConfig `toml:"gateway"`
}

func DefaultConfig

func DefaultConfig() *Config

type GatewayConfig

type GatewayConfig struct {
	Enable     bool   `toml:"enable"`
	Listen     string `toml:"listen"`
	EnableCORS bool   `toml:"enable_cors"`
}

type Server

type Server struct {
	// contains filtered or unexported fields
}

func NewServer

func NewServer(conf *Config, st state.Facade, syn sync.Synchronizer,
	n network.Network, consMgr consensus.ManagerReader,
) *Server

func (*Server) Address

func (s *Server) Address() string

func (*Server) StartServer

func (s *Server) StartServer() error

func (*Server) StopServer

func (s *Server) StopServer()