toyblc

Documentation

Index

• func InitializeWebServer(config *Config) (server.Server, error)
• func InstallGenericAPI(engine *gin.Engine)
• func NewAggregatorServer(serverConfig *ServerConfig) (server.Server, error)
• type AggregatorServer
  • func (s *AggregatorServer) GracefulStop(ctx context.Context)
  • func (s *AggregatorServer) RunOrDie()
• type Config
  • func (cfg *Config) NewServer(ctx context.Context) (*Server, error)
• type Server
  • func (s *Server) Run(ctx context.Context) error
• type ServerConfig
  • func (c *ServerConfig) InstallRESTAPI(engine *gin.Engine)
  • func (c *ServerConfig) NewBlockChainServer() *blcServer
  • func (c *ServerConfig) NewP2PServer() *p2pServer

Functions

func InitializeWebServer

func InitializeWebServer(config *Config) (server.Server, error)

InitializeWebServer sets up and initializes the web server with all necessary dependencies.

func InstallGenericAPI

func InstallGenericAPI(engine *gin.Engine)

InstallGenericAPI 注册业务无关的路由，例如 pprof、404 处理等.

func NewAggregatorServer

func NewAggregatorServer(serverConfig *ServerConfig) (server.Server, error)

Types

type AggregatorServer

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

func (*AggregatorServer) GracefulStop

func (s *AggregatorServer) GracefulStop(ctx context.Context)

func (*AggregatorServer) RunOrDie

func (s *AggregatorServer) RunOrDie()

type Config

type Config struct {
	Miner           bool
	MinMineInterval time.Duration
	Address         string
	Accounts        map[string]string
	HTTPOptions     *genericoptions.HTTPOptions
	TLSOptions      *genericoptions.TLSOptions
	P2PAddr         string
	Peers           []string
}

Config contains application-related configurations.

func (*Config) NewServer

func (cfg *Config) NewServer(ctx context.Context) (*Server, error)

NewServer initializes and returns a new Server instance.

type Server

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

Server represents the web server.

func (*Server) Run

func (s *Server) Run(ctx context.Context) error

Run starts the server and listens for termination signals. It gracefully shuts down the server upon receiving a termination signal.

type ServerConfig

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

ServerConfig contains the core dependencies and configurations of the server.

func (*ServerConfig) InstallRESTAPI

func (c *ServerConfig) InstallRESTAPI(engine *gin.Engine)

注册 API 路由。路由的路径和 HTTP 方法，严格遵循 REST 规范.

func (*ServerConfig) NewBlockChainServer

func (c *ServerConfig) NewBlockChainServer() *blcServer

func (*ServerConfig) NewP2PServer

func (c *ServerConfig) NewP2PServer() *p2pServer