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

• func BasicAuth(storedCredential string) grpc.UnaryServerInterceptor
• type Config
  • func DefaultConfig() *Config
  • func (c *Config) BasicCheck() error
• type GatewayConfig
• type Server
  • func NewServer(conf *Config, state state.Facade, sync sync.Synchronizer, ...) *Server
  • func (s *Server) Address() string
  • func (s *Server) Recovery() grpc.UnaryServerInterceptor
  • func (s *Server) StartServer() error
  • func (s *Server) StopServer()

Functions

func BasicAuth

func BasicAuth(storedCredential string) grpc.UnaryServerInterceptor

Types

type Config

type Config struct {
	Enable       bool          `toml:"enable"`
	EnableWallet bool          `toml:"enable_wallet"`
	Listen       string        `toml:"listen"`
	BasicAuth    string        `toml:"basic_auth"`
	Gateway      GatewayConfig `toml:"gateway"`

	// Private config
	WalletsDir        string `toml:"-"`
	DefaultWalletName string `toml:"-"`
}

func DefaultConfig

func DefaultConfig() *Config

func (*Config) BasicCheck

func (c *Config) BasicCheck() error

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, state state.Facade, sync sync.Synchronizer,
	network network.Network, consMgr consensus.ManagerReader,
	walletMgr *wallet.Manager,
) *Server

func (*Server) Address

func (s *Server) Address() string

func (*Server) Recovery

func (s *Server) Recovery() grpc.UnaryServerInterceptor

func (*Server) StartServer

func (s *Server) StartServer() error

func (*Server) StopServer

func (s *Server) StopServer()