privileged

Documentation

Index

• func Serve(listener net.Listener, opts ...Option) error
• type Option
  • func WithGRPCOption(opt grpc.ServerOption) Option
  • func WithLogger(logger log.Logger) Option
  • func WithPruningService(pruner *sm.Pruner, logger log.Logger) Option

Functions

func Serve

func Serve(listener net.Listener, opts ...Option) error

Serve constructs and runs a CometBFT privileged gRPC server using the given listener and options.

This function only returns upon error, otherwise it blocks the current goroutine.

Types

type Option

type Option func(*serverBuilder)

Option is any function that allows for configuration of the gRPC server during its creation.

func WithGRPCOption

func WithGRPCOption(opt grpc.ServerOption) Option

WithGRPCOption allows one to specify Google gRPC server options during the construction of the CometBFT gRPC server.

func WithLogger

func WithLogger(logger log.Logger) Option

WithLogger enables logging using the given logger. If not specified, the gRPC server does not log anything.

func WithPruningService

func WithPruningService(pruner *sm.Pruner, logger log.Logger) Option

WithVersionService enables the version service on the CometBFT server.