mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2024-12-28 14:17:17 +00:00
d9c0e65cef
* info logs beacon node improvements * prom test fixes * info logging changes * wrapped up node info logging * changed to debug level * warn logs taken care of * Terence suggestion * warn spacing * better logging in initial sync * debug level standardized * complete debug standardization * participation at epoch end * fix archive tests * even more test fixes * prom test * ops test * powtest * rpc sync test * rem part * log formatting
247 lines
8.7 KiB
Go
247 lines
8.7 KiB
Go
// Package rpc defines the services that the beacon-chain uses to communicate via gRPC.
|
|
package rpc
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net"
|
|
"time"
|
|
|
|
middleware "github.com/grpc-ecosystem/go-grpc-middleware"
|
|
recovery "github.com/grpc-ecosystem/go-grpc-middleware/recovery"
|
|
grpc_opentracing "github.com/grpc-ecosystem/go-grpc-middleware/tracing/opentracing"
|
|
grpc_prometheus "github.com/grpc-ecosystem/go-grpc-prometheus"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/blockchain"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/cache"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/cache/depositcache"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/db"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/operations"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/p2p"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/powchain"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/sync"
|
|
pbp2p "github.com/prysmaticlabs/prysm/proto/beacon/p2p/v1"
|
|
pb "github.com/prysmaticlabs/prysm/proto/beacon/rpc/v1"
|
|
ethpb "github.com/prysmaticlabs/prysm/proto/eth/v1alpha1"
|
|
"github.com/prysmaticlabs/prysm/shared/params"
|
|
"github.com/sirupsen/logrus"
|
|
"go.opencensus.io/plugin/ocgrpc"
|
|
"google.golang.org/grpc"
|
|
"google.golang.org/grpc/credentials"
|
|
"google.golang.org/grpc/reflection"
|
|
)
|
|
|
|
var log logrus.FieldLogger
|
|
|
|
func init() {
|
|
log = logrus.WithField("prefix", "rpc")
|
|
}
|
|
|
|
// Service defining an RPC server for a beacon node.
|
|
type Service struct {
|
|
ctx context.Context
|
|
cancel context.CancelFunc
|
|
beaconDB db.Database
|
|
stateFeedListener blockchain.ChainFeeds
|
|
headFetcher blockchain.HeadFetcher
|
|
forkFetcher blockchain.ForkFetcher
|
|
finalizationFetcher blockchain.FinalizationFetcher
|
|
genesisTimeFetcher blockchain.GenesisTimeFetcher
|
|
attestationReceiver blockchain.AttestationReceiver
|
|
blockReceiver blockchain.BlockReceiver
|
|
powChainService powchain.Chain
|
|
chainStartFetcher powchain.ChainStartFetcher
|
|
mockEth1Votes bool
|
|
attestationsPool operations.Pool
|
|
operationsHandler operations.Handler
|
|
syncService sync.Checker
|
|
port string
|
|
listener net.Listener
|
|
withCert string
|
|
withKey string
|
|
grpcServer *grpc.Server
|
|
canonicalStateChan chan *pbp2p.BeaconState
|
|
incomingAttestation chan *ethpb.Attestation
|
|
credentialError error
|
|
p2p p2p.Broadcaster
|
|
depositFetcher depositcache.DepositFetcher
|
|
pendingDepositFetcher depositcache.PendingDepositsFetcher
|
|
}
|
|
|
|
// Config options for the beacon node RPC server.
|
|
type Config struct {
|
|
Port string
|
|
CertFlag string
|
|
KeyFlag string
|
|
BeaconDB db.Database
|
|
StateFeedListener blockchain.ChainFeeds
|
|
HeadFetcher blockchain.HeadFetcher
|
|
ForkFetcher blockchain.ForkFetcher
|
|
FinalizationFetcher blockchain.FinalizationFetcher
|
|
AttestationReceiver blockchain.AttestationReceiver
|
|
BlockReceiver blockchain.BlockReceiver
|
|
POWChainService powchain.Chain
|
|
ChainStartFetcher powchain.ChainStartFetcher
|
|
GenesisTimeFetcher blockchain.GenesisTimeFetcher
|
|
MockEth1Votes bool
|
|
OperationsHandler operations.Handler
|
|
AttestationsPool operations.Pool
|
|
SyncService sync.Checker
|
|
Broadcaster p2p.Broadcaster
|
|
DepositFetcher depositcache.DepositFetcher
|
|
PendingDepositFetcher depositcache.PendingDepositsFetcher
|
|
}
|
|
|
|
// NewService instantiates a new RPC service instance that will
|
|
// be registered into a running beacon node.
|
|
func NewService(ctx context.Context, cfg *Config) *Service {
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
return &Service{
|
|
ctx: ctx,
|
|
cancel: cancel,
|
|
beaconDB: cfg.BeaconDB,
|
|
stateFeedListener: cfg.StateFeedListener,
|
|
headFetcher: cfg.HeadFetcher,
|
|
forkFetcher: cfg.ForkFetcher,
|
|
finalizationFetcher: cfg.FinalizationFetcher,
|
|
genesisTimeFetcher: cfg.GenesisTimeFetcher,
|
|
attestationReceiver: cfg.AttestationReceiver,
|
|
blockReceiver: cfg.BlockReceiver,
|
|
p2p: cfg.Broadcaster,
|
|
powChainService: cfg.POWChainService,
|
|
chainStartFetcher: cfg.ChainStartFetcher,
|
|
mockEth1Votes: cfg.MockEth1Votes,
|
|
attestationsPool: cfg.AttestationsPool,
|
|
operationsHandler: cfg.OperationsHandler,
|
|
syncService: cfg.SyncService,
|
|
port: cfg.Port,
|
|
withCert: cfg.CertFlag,
|
|
withKey: cfg.KeyFlag,
|
|
depositFetcher: cfg.DepositFetcher,
|
|
pendingDepositFetcher: cfg.PendingDepositFetcher,
|
|
canonicalStateChan: make(chan *pbp2p.BeaconState, params.BeaconConfig().DefaultBufferSize),
|
|
incomingAttestation: make(chan *ethpb.Attestation, params.BeaconConfig().DefaultBufferSize),
|
|
}
|
|
}
|
|
|
|
// Start the gRPC server.
|
|
func (s *Service) Start() {
|
|
lis, err := net.Listen("tcp", fmt.Sprintf(":%s", s.port))
|
|
if err != nil {
|
|
log.Errorf("Could not listen to port in Start() :%s: %v", s.port, err)
|
|
}
|
|
s.listener = lis
|
|
log.WithField("port", fmt.Sprintf(":%s", s.port)).Info("RPC-API listening on port")
|
|
|
|
opts := []grpc.ServerOption{
|
|
grpc.StatsHandler(&ocgrpc.ServerHandler{}),
|
|
grpc.StreamInterceptor(middleware.ChainStreamServer(
|
|
recovery.StreamServerInterceptor(),
|
|
grpc_prometheus.StreamServerInterceptor,
|
|
grpc_opentracing.StreamServerInterceptor(),
|
|
)),
|
|
grpc.UnaryInterceptor(middleware.ChainUnaryServer(
|
|
recovery.UnaryServerInterceptor(),
|
|
grpc_prometheus.UnaryServerInterceptor,
|
|
grpc_opentracing.UnaryServerInterceptor(),
|
|
)),
|
|
}
|
|
// TODO(#791): Utilize a certificate for secure connections
|
|
// between beacon nodes and validator clients.
|
|
if s.withCert != "" && s.withKey != "" {
|
|
creds, err := credentials.NewServerTLSFromFile(s.withCert, s.withKey)
|
|
if err != nil {
|
|
log.Errorf("Could not load TLS keys: %s", err)
|
|
s.credentialError = err
|
|
}
|
|
opts = append(opts, grpc.Creds(creds))
|
|
} else {
|
|
log.Warn("You are using an insecure gRPC connection! Provide a certificate and key to connect securely")
|
|
}
|
|
s.grpcServer = grpc.NewServer(opts...)
|
|
|
|
proposerServer := &ProposerServer{
|
|
beaconDB: s.beaconDB,
|
|
headFetcher: s.headFetcher,
|
|
blockReceiver: s.blockReceiver,
|
|
chainStartFetcher: s.chainStartFetcher,
|
|
eth1InfoFetcher: s.powChainService,
|
|
eth1BlockFetcher: s.powChainService,
|
|
mockEth1Votes: s.mockEth1Votes,
|
|
pool: s.attestationsPool,
|
|
canonicalStateChan: s.canonicalStateChan,
|
|
depositFetcher: s.depositFetcher,
|
|
pendingDepositsFetcher: s.pendingDepositFetcher,
|
|
}
|
|
attesterServer := &AttesterServer{
|
|
p2p: s.p2p,
|
|
beaconDB: s.beaconDB,
|
|
operationsHandler: s.operationsHandler,
|
|
attReceiver: s.attestationReceiver,
|
|
headFetcher: s.headFetcher,
|
|
attestationCache: cache.NewAttestationCache(),
|
|
}
|
|
validatorServer := &ValidatorServer{
|
|
ctx: s.ctx,
|
|
beaconDB: s.beaconDB,
|
|
headFetcher: s.headFetcher,
|
|
forkFetcher: s.forkFetcher,
|
|
canonicalStateChan: s.canonicalStateChan,
|
|
blockFetcher: s.powChainService,
|
|
chainStartFetcher: s.chainStartFetcher,
|
|
depositFetcher: s.depositFetcher,
|
|
stateFeedListener: s.stateFeedListener,
|
|
chainStartChan: make(chan time.Time),
|
|
}
|
|
nodeServer := &NodeServer{
|
|
beaconDB: s.beaconDB,
|
|
server: s.grpcServer,
|
|
syncChecker: s.syncService,
|
|
genesisTimeFetcher: s.genesisTimeFetcher,
|
|
}
|
|
beaconChainServer := &BeaconChainServer{
|
|
beaconDB: s.beaconDB,
|
|
pool: s.attestationsPool,
|
|
headFetcher: s.headFetcher,
|
|
finalizationFetcher: s.finalizationFetcher,
|
|
chainStartFetcher: s.chainStartFetcher,
|
|
canonicalStateChan: s.canonicalStateChan,
|
|
}
|
|
pb.RegisterProposerServiceServer(s.grpcServer, proposerServer)
|
|
pb.RegisterAttesterServiceServer(s.grpcServer, attesterServer)
|
|
pb.RegisterValidatorServiceServer(s.grpcServer, validatorServer)
|
|
ethpb.RegisterNodeServer(s.grpcServer, nodeServer)
|
|
ethpb.RegisterBeaconChainServer(s.grpcServer, beaconChainServer)
|
|
|
|
// Register reflection service on gRPC server.
|
|
reflection.Register(s.grpcServer)
|
|
|
|
go func() {
|
|
for s.syncService.Status() != nil {
|
|
time.Sleep(time.Second * params.BeaconConfig().RPCSyncCheck)
|
|
}
|
|
if s.listener != nil {
|
|
if err := s.grpcServer.Serve(s.listener); err != nil {
|
|
log.Errorf("Could not serve gRPC: %v", err)
|
|
}
|
|
}
|
|
}()
|
|
}
|
|
|
|
// Stop the service.
|
|
func (s *Service) Stop() error {
|
|
s.cancel()
|
|
if s.listener != nil {
|
|
s.grpcServer.GracefulStop()
|
|
log.Debug("Initiated graceful stop of gRPC server")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Status returns nil or credentialError
|
|
func (s *Service) Status() error {
|
|
if s.credentialError != nil {
|
|
return s.credentialError
|
|
}
|
|
return nil
|
|
}
|