net

Documentation

Index

• Variables
• func NewGrpcClient(opts ...grpc.DialOption) *grpcClient
• func NewGrpcClientFromCertManager(c *CertManager, opts ...grpc.DialOption) *grpcClient
• func NewGrpcClientWithTimeout(timeout time.Duration, opts ...grpc.DialOption) *grpcClient
• type CallOption
• type CertManager
  • func NewCertManager() *CertManager
  • func (p *CertManager) Add(certPath string) error
  • func (p *CertManager) Pool() *x509.CertPool
• type DefaultService
  • func (s *DefaultService) DistKey(c context.Context, in *drand.DistKeyRequest) (*drand.DistKeyResponse, error)
  • func (s *DefaultService) NewBeacon(c context.Context, in *drand.BeaconRequest) (*drand.BeaconResponse, error)
  • func (s *DefaultService) Private(c context.Context, in *drand.PrivateRandRequest) (*drand.PrivateRandResponse, error)
  • func (s *DefaultService) Public(c context.Context, in *drand.PublicRandRequest) (*drand.PublicRandResponse, error)
  • func (s *DefaultService) Setup(c context.Context, in *dkg.DKGPacket) (*dkg.DKGResponse, error)
• type ExternalClient
  • func NewRestClient() ExternalClient
  • func NewRestClientFromCertManager(c *CertManager) ExternalClient
• type Gateway
  • func NewGrpcGateway(listen string, certPath, keyPath string, s Service, opts ...grpc.DialOption) Gateway
  • func NewGrpcGatewayFromCertManager(listen string, certPath, keyPath string, certs *CertManager, s Service, ...) Gateway
  • func NewGrpcGatewayInsecure(listen string, s Service, opts ...grpc.DialOption) Gateway
• type InternalClient
• type Listener
  • func NewTCPGrpcListener(addr string, s Service, opts ...grpc.ServerOption) Listener
  • func NewTLSGrpcListener(bindingAddr string, certPath, keyPath string, s Service, ...) (Listener, error)
• type Peer
• type Service

Variables

var DefaultTimeout = time.Duration(30) * time.Second

Functions

func NewGrpcClient

func NewGrpcClient(opts ...grpc.DialOption) *grpcClient

NewGrpcClient returns an implementation of an InternalClient and ExternalClient using gRPC connections

func NewGrpcClientFromCertManager

func NewGrpcClientFromCertManager(c *CertManager, opts ...grpc.DialOption) *grpcClient

func NewGrpcClientWithTimeout

func NewGrpcClientWithTimeout(timeout time.Duration, opts ...grpc.DialOption) *grpcClient

Types

type CallOption

type CallOption = grpc.CallOption

type CertManager

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

CertManager is used to managed certificates. It is most commonly used for testing with self signed certificate. By default, it returns the bundled set of certificates coming with the OS (Go's implementation).

func NewCertManager

func NewCertManager() *CertManager

func (*CertManager) Add

func (p *CertManager) Add(certPath string) error

func (*CertManager) Pool

func (p *CertManager) Pool() *x509.CertPool

type DefaultService

type DefaultService struct {
	B drand.BeaconServer
	R drand.RandomnessServer
	I drand.InfoServer
	D dkg.DkgServer
}

Default service implements the Service interface with methods that returns empty messages. Default service is useful mainly for testing, where you want to implement only a specific functionality of a Service. To use : depending on which server you want to test, define a struct that implemants BeaconServer, RandomnessServer or DkgServer and instanciate defaultService with &DefaultService{<your struct>}.

func (*DefaultService) DistKey

func (s *DefaultService) DistKey(c context.Context, in *drand.DistKeyRequest) (*drand.DistKeyResponse, error)

func (*DefaultService) NewBeacon

func (s *DefaultService) NewBeacon(c context.Context, in *drand.BeaconRequest) (*drand.BeaconResponse, error)

func (*DefaultService) Private

func (s *DefaultService) Private(c context.Context, in *drand.PrivateRandRequest) (*drand.PrivateRandResponse, error)

func (*DefaultService) Public

func (s *DefaultService) Public(c context.Context, in *drand.PublicRandRequest) (*drand.PublicRandResponse, error)

func (*DefaultService) Setup

func (s *DefaultService) Setup(c context.Context, in *dkg.DKGPacket) (*dkg.DKGResponse, error)

type ExternalClient

type ExternalClient interface {
	Public(p Peer, in *drand.PublicRandRequest) (*drand.PublicRandResponse, error)
	Private(p Peer, in *drand.PrivateRandRequest) (*drand.PrivateRandResponse, error)
	DistKey(p Peer, in *drand.DistKeyRequest) (*drand.DistKeyResponse, error)
}

func NewRestClient

func NewRestClient() ExternalClient

func NewRestClientFromCertManager

func NewRestClientFromCertManager(c *CertManager) ExternalClient

type Gateway

type Gateway struct {
	Listener
	InternalClient
}

Gateway is the main interface to communicate to the drand world. It acts as a listener to receive incoming requests and acts a client connecting to drand particpants. The gateway fixes all drand functionalities offered by drand.

func NewGrpcGateway

func NewGrpcGateway(listen string, certPath, keyPath string, s Service, opts ...grpc.DialOption) Gateway

func NewGrpcGatewayFromCertManager

func NewGrpcGatewayFromCertManager(listen string, certPath, keyPath string, certs *CertManager, s Service, opts ...grpc.DialOption) Gateway

func NewGrpcGatewayInsecure

func NewGrpcGatewayInsecure(listen string, s Service, opts ...grpc.DialOption) Gateway

type InternalClient

type InternalClient interface {
	NewBeacon(p Peer, in *drand.BeaconRequest, opts ...CallOption) (*drand.BeaconResponse, error)
	Setup(p Peer, in *dkg.DKGPacket, opts ...CallOption) (*dkg.DKGResponse, error)
}

InternalClient represents all methods callable on drand nodes which are internal to the system. See the folder api/ to get more info on the external API drand nodes offer.

type Listener

type Listener interface {
	Service
	Start()
	Stop()
}

Listener is the active listener for incoming requests.

func NewTCPGrpcListener

func NewTCPGrpcListener(addr string, s Service, opts ...grpc.ServerOption) Listener

NewTCPGrpcListener returns a gRPC listener using plain TCP connections without TLS. The listener will bind to the given address:port tuple.

func NewTLSGrpcListener

func NewTLSGrpcListener(bindingAddr string, certPath, keyPath string, s Service, opts ...grpc.ServerOption) (Listener, error)

type Peer

type Peer interface {
	Address() string
	IsTLS() bool
}

Peer is a simple interface that allows retrieving the address of a destination. It might further e enhanced with certificates properties and all.

type Service

type Service interface {
	drand.RandomnessServer
	drand.InfoServer
	drand.BeaconServer
	dkg.DkgServer
}

Service holds all functionalities that a drand node should implement