rpc

Documentation

Overview

Package rpc defines the services that the beacon-chain uses to communicate via gRPC.

Index

• type Config
• type Service
  • func NewService(ctx context.Context, cfg *Config) *Service
  • func (s *Service) Start()
  • func (s *Service) Status() error
  • func (s *Service) Stop() error

Types

type Config

type Config struct {
	Host                  string
	Port                  string
	CertFlag              string
	KeyFlag               string
	BeaconDB              db.HeadAccessDatabase
	HeadFetcher           blockchain.HeadFetcher
	ForkFetcher           blockchain.ForkFetcher
	FinalizationFetcher   blockchain.FinalizationFetcher
	ParticipationFetcher  blockchain.ParticipationFetcher
	AttestationReceiver   blockchain.AttestationReceiver
	BlockReceiver         blockchain.BlockReceiver
	POWChainService       powchain.Chain
	ChainStartFetcher     powchain.ChainStartFetcher
	GenesisTimeFetcher    blockchain.TimeFetcher
	MockEth1Votes         bool
	AttestationsPool      attestations.Pool
	ExitPool              *voluntaryexits.Pool
	SlashingsPool         *slashings.Pool
	SyncService           sync.Checker
	Broadcaster           p2p.Broadcaster
	PeersFetcher          p2p.PeersProvider
	DepositFetcher        depositcache.DepositFetcher
	PendingDepositFetcher depositcache.PendingDepositsFetcher
	SlasherProvider       string
	SlasherCert           string
	StateNotifier         statefeed.Notifier
	BlockNotifier         blockfeed.Notifier
	OperationNotifier     opfeed.Notifier
}

Config options for the beacon node RPC server.

type Service

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

Service defining an RPC server for a beacon node.

func NewService

func NewService(ctx context.Context, cfg *Config) *Service

NewService instantiates a new RPC service instance that will be registered into a running beacon node.

func (*Service) Start

func (s *Service) Start()

Start the gRPC server.

func (*Service) Status

func (s *Service) Status() error

Status returns nil or credentialError

func (*Service) Stop

func (s *Service) Stop() error

Stop the service.