Restructure Beacon Chain RPC Servers Into Subpackages

beacon-chain/rpc/BUILD.bazel

@@ -2,108 +2,51 @@ load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
 
 go_library(
     name = "go_default_library",
-    srcs = [
-        "attester_server.go",
-        "beacon_chain_server.go",
-        "node_server.go",
-        "proposer_server.go",
-        "service.go",
-        "validator_server.go",
-    ],
+    srcs = ["service.go"],
     importpath = "github.com/prysmaticlabs/prysm/beacon-chain/rpc",
     visibility = ["//beacon-chain:__subpackages__"],
     deps = [
         "//beacon-chain/blockchain:go_default_library",
         "//beacon-chain/cache:go_default_library",
         "//beacon-chain/cache/depositcache:go_default_library",
-        "//beacon-chain/core/blocks:go_default_library",
-        "//beacon-chain/core/epoch:go_default_library",
-        "//beacon-chain/core/helpers:go_default_library",
-        "//beacon-chain/core/state:go_default_library",
-        "//beacon-chain/core/state/interop:go_default_library",
-        "//beacon-chain/core/validators:go_default_library",
         "//beacon-chain/db:go_default_library",
-        "//beacon-chain/db/filters:go_default_library",
         "//beacon-chain/operations:go_default_library",
         "//beacon-chain/p2p:go_default_library",
         "//beacon-chain/powchain:go_default_library",
+        "//beacon-chain/rpc/attester:go_default_library",
+        "//beacon-chain/rpc/beacon:go_default_library",
+        "//beacon-chain/rpc/node:go_default_library",
+        "//beacon-chain/rpc/proposer:go_default_library",
+        "//beacon-chain/rpc/validator:go_default_library",
         "//beacon-chain/sync:go_default_library",
         "//proto/beacon/p2p/v1:go_default_library",
         "//proto/beacon/rpc/v1:go_default_library",
         "//proto/eth/v1alpha1:go_default_library",
-        "//shared/bytesutil:go_default_library",
-        "//shared/hashutil:go_default_library",
-        "//shared/pagination:go_default_library",
         "//shared/params:go_default_library",
         "//shared/traceutil:go_default_library",
-        "//shared/trieutil:go_default_library",
-        "//shared/version:go_default_library",
-        "@com_github_gogo_protobuf//proto:go_default_library",
-        "@com_github_gogo_protobuf//types:go_default_library",
         "@com_github_grpc_ecosystem_go_grpc_middleware//:go_default_library",
         "@com_github_grpc_ecosystem_go_grpc_middleware//recovery:go_default_library",
         "@com_github_grpc_ecosystem_go_grpc_middleware//tracing/opentracing:go_default_library",
         "@com_github_grpc_ecosystem_go_grpc_prometheus//:go_default_library",
-        "@com_github_pkg_errors//:go_default_library",
-        "@com_github_prysmaticlabs_go_ssz//:go_default_library",
         "@com_github_sirupsen_logrus//:go_default_library",
         "@io_opencensus_go//plugin/ocgrpc:go_default_library",
-        "@io_opencensus_go//trace:go_default_library",
         "@org_golang_google_grpc//:go_default_library",
-        "@org_golang_google_grpc//codes:go_default_library",
         "@org_golang_google_grpc//credentials:go_default_library",
         "@org_golang_google_grpc//reflection:go_default_library",
-        "@org_golang_google_grpc//status:go_default_library",
     ],
 )
 
 go_test(
     name = "go_default_test",
     size = "medium",
-    srcs = [
-        "attester_server_test.go",
-        "beacon_chain_server_test.go",
-        "node_server_test.go",
-        "proposer_server_test.go",
-        "service_test.go",
-        "validator_server_test.go",
-    ],
+    srcs = ["service_test.go"],
     embed = [":go_default_library"],
     deps = [
         "//beacon-chain/blockchain/testing:go_default_library",
-        "//beacon-chain/cache:go_default_library",
-        "//beacon-chain/cache/depositcache:go_default_library",
-        "//beacon-chain/core/blocks:go_default_library",
-        "//beacon-chain/core/helpers:go_default_library",
-        "//beacon-chain/core/state:go_default_library",
-        "//beacon-chain/db:go_default_library",
-        "//beacon-chain/db/testing:go_default_library",
-        "//beacon-chain/operations/testing:go_default_library",
-        "//beacon-chain/p2p/testing:go_default_library",
         "//beacon-chain/powchain/testing:go_default_library",
-        "//beacon-chain/rpc/testing:go_default_library",
         "//beacon-chain/sync/initial-sync/testing:go_default_library",
-        "//proto/beacon/p2p/v1:go_default_library",
-        "//proto/beacon/rpc/v1:go_default_library",
-        "//proto/eth/v1alpha1:go_default_library",
-        "//shared/bls:go_default_library",
-        "//shared/bytesutil:go_default_library",
-        "//shared/event:go_default_library",
-        "//shared/featureconfig:go_default_library",
-        "//shared/hashutil:go_default_library",
-        "//shared/params:go_default_library",
         "//shared/testutil:go_default_library",
-        "//shared/trieutil:go_default_library",
-        "//shared/version:go_default_library",
-        "@com_github_ethereum_go_ethereum//common:go_default_library",
-        "@com_github_gogo_protobuf//proto:go_default_library",
-        "@com_github_gogo_protobuf//types:go_default_library",
-        "@com_github_golang_mock//gomock:go_default_library",
-        "@com_github_prysmaticlabs_go_bitfield//:go_default_library",
-        "@com_github_prysmaticlabs_go_ssz//:go_default_library",
         "@com_github_sirupsen_logrus//:go_default_library",
         "@com_github_sirupsen_logrus//hooks/test:go_default_library",
-        "@org_golang_google_grpc//:go_default_library",
-        "@org_golang_google_grpc//reflection:go_default_library",
     ],
 )

beacon-chain/rpc/attester/BUILD.bazel

@@ -0,0 +1,49 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+
+go_library(
+    name = "go_default_library",
+    srcs = ["server.go"],
+    importpath = "github.com/prysmaticlabs/prysm/beacon-chain/rpc/attester",
+    visibility = ["//beacon-chain:__subpackages__"],
+    deps = [
+        "//beacon-chain/blockchain:go_default_library",
+        "//beacon-chain/cache:go_default_library",
+        "//beacon-chain/core/helpers:go_default_library",
+        "//beacon-chain/core/state:go_default_library",
+        "//beacon-chain/db:go_default_library",
+        "//beacon-chain/operations:go_default_library",
+        "//beacon-chain/p2p:go_default_library",
+        "//beacon-chain/sync:go_default_library",
+        "//proto/beacon/rpc/v1:go_default_library",
+        "//proto/eth/v1alpha1:go_default_library",
+        "@com_github_gogo_protobuf//proto:go_default_library",
+        "@com_github_pkg_errors//:go_default_library",
+        "@com_github_prysmaticlabs_go_ssz//:go_default_library",
+        "@com_github_sirupsen_logrus//:go_default_library",
+        "@io_opencensus_go//trace:go_default_library",
+        "@org_golang_google_grpc//codes:go_default_library",
+        "@org_golang_google_grpc//status:go_default_library",
+    ],
+)
+
+go_test(
+    name = "go_default_test",
+    srcs = ["server_test.go"],
+    embed = [":go_default_library"],
+    deps = [
+        "//beacon-chain/blockchain/testing:go_default_library",
+        "//beacon-chain/cache:go_default_library",
+        "//beacon-chain/core/helpers:go_default_library",
+        "//beacon-chain/db/testing:go_default_library",
+        "//beacon-chain/operations/testing:go_default_library",
+        "//beacon-chain/p2p/testing:go_default_library",
+        "//beacon-chain/sync/initial-sync/testing:go_default_library",
+        "//proto/beacon/p2p/v1:go_default_library",
+        "//proto/beacon/rpc/v1:go_default_library",
+        "//proto/eth/v1alpha1:go_default_library",
+        "//shared/featureconfig:go_default_library",
+        "//shared/params:go_default_library",
+        "@com_github_gogo_protobuf//proto:go_default_library",
+        "@com_github_prysmaticlabs_go_ssz//:go_default_library",
+    ],
+)

beacon-chain/rpc/attester_server.go → beacon-chain/rpc/attester/server.go

@@ -1,4 +1,4 @@
-package rpc
+package attester
 
 import (
 	"context"
@@ -16,26 +16,33 @@ import (
 	"github.com/prysmaticlabs/prysm/beacon-chain/sync"
 	pb "github.com/prysmaticlabs/prysm/proto/beacon/rpc/v1"
 	ethpb "github.com/prysmaticlabs/prysm/proto/eth/v1alpha1"
+	"github.com/sirupsen/logrus"
 	"go.opencensus.io/trace"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 )
 
-// AttesterServer defines a server implementation of the gRPC Attester service,
+var log logrus.FieldLogger
+
+func init() {
+	log = logrus.WithField("prefix", "rpc/attester")
+}
+
+// Server defines a server implementation of the gRPC Attester service,
 // providing RPC methods for validators acting as attesters to broadcast votes on beacon blocks.
-type AttesterServer struct {
-	p2p               p2p.Broadcaster
-	beaconDB          db.Database
-	operationsHandler operations.Handler
-	attReceiver       blockchain.AttestationReceiver
-	headFetcher       blockchain.HeadFetcher
-	attestationCache  *cache.AttestationCache
-	syncChecker       sync.Checker
+type Server struct {
+	P2p               p2p.Broadcaster
+	BeaconDB          db.Database
+	OperationsHandler operations.Handler
+	AttReceiver       blockchain.AttestationReceiver
+	HeadFetcher       blockchain.HeadFetcher
+	AttestationCache  *cache.AttestationCache
+	SyncChecker       sync.Checker
 }
 
 // SubmitAttestation is a function called by an attester in a sharding validator to vote
 // on a block via an attestation object as defined in the Ethereum Serenity specification.
-func (as *AttesterServer) SubmitAttestation(ctx context.Context, att *ethpb.Attestation) (*pb.AttestResponse, error) {
+func (as *Server) SubmitAttestation(ctx context.Context, att *ethpb.Attestation) (*pb.AttestResponse, error) {
 	root, err := ssz.HashTreeRoot(att.Data)
 	if err != nil {
 		return nil, errors.Wrap(err, "failed to hash tree root attestation")
@@ -44,11 +51,11 @@ func (as *AttesterServer) SubmitAttestation(ctx context.Context, att *ethpb.Atte
 	go func() {
 		ctx = trace.NewContext(context.Background(), trace.FromContext(ctx))
 		attCopy := proto.Clone(att).(*ethpb.Attestation)
-		if err := as.attReceiver.ReceiveAttestation(ctx, att); err != nil {
+		if err := as.AttReceiver.ReceiveAttestation(ctx, att); err != nil {
 			log.WithError(err).Error("could not receive attestation in chain service")
 			return
 		}
-		if err := as.operationsHandler.HandleAttestation(ctx, attCopy); err != nil {
+		if err := as.OperationsHandler.HandleAttestation(ctx, attCopy); err != nil {
 			log.WithError(err).Error("could not handle attestation in operations service")
 			return
 		}
@@ -59,19 +66,19 @@ func (as *AttesterServer) SubmitAttestation(ctx context.Context, att *ethpb.Atte
 
 // RequestAttestation requests that the beacon node produce an IndexedAttestation,
 // with a blank signature field, which the validator will then sign.
-func (as *AttesterServer) RequestAttestation(ctx context.Context, req *pb.AttestationRequest) (*ethpb.AttestationData, error) {
+func (as *Server) RequestAttestation(ctx context.Context, req *pb.AttestationRequest) (*ethpb.AttestationData, error) {
 	ctx, span := trace.StartSpan(ctx, "AttesterServer.RequestAttestation")
 	defer span.End()
 	span.AddAttributes(
 		trace.Int64Attribute("slot", int64(req.Slot)),
 		trace.Int64Attribute("committeeIndex", int64(req.CommitteeIndex)),
 	)
 
-	if as.syncChecker.Syncing() {
+	if as.SyncChecker.Syncing() {
 		return nil, status.Errorf(codes.Unavailable, "Syncing to latest head, not ready to respond")
 	}
 
-	res, err := as.attestationCache.Get(ctx, req)
+	res, err := as.AttestationCache.Get(ctx, req)
 	if err != nil {
 		return nil, err
 	}
@@ -80,9 +87,9 @@ func (as *AttesterServer) RequestAttestation(ctx context.Context, req *pb.Attest
 		return res, nil
 	}
 
-	if err := as.attestationCache.MarkInProgress(req); err != nil {
+	if err := as.AttestationCache.MarkInProgress(req); err != nil {
 		if err == cache.ErrAlreadyInProgress {
-			res, err := as.attestationCache.Get(ctx, req)
+			res, err := as.AttestationCache.Get(ctx, req)
 			if err != nil {
 				return nil, err
 			}
@@ -95,17 +102,25 @@ func (as *AttesterServer) RequestAttestation(ctx context.Context, req *pb.Attest
 		return nil, err
 	}
 	defer func() {
-		if err := as.attestationCache.MarkNotInProgress(req); err != nil {
+		if err := as.AttestationCache.MarkNotInProgress(req); err != nil {
 			log.WithError(err).Error("Failed to mark cache not in progress")
 		}
 	}()
 
-	headState := as.headFetcher.HeadState()
-	headRoot := as.headFetcher.HeadRoot()
+	headState := as.HeadFetcher.HeadState()
+	headRoot := as.HeadFetcher.HeadRoot()
+
+	// Safe guard against head state is nil in chain service. This should not happen.
+	if headState == nil {
+		headState, err = as.BeaconDB.HeadState(ctx)
+		if err != nil {
+			return nil, err
+		}
+	}
 
 	// Safe guard against head state is nil in chain service. This should not happen.
 	if headState == nil {
-		headState, err = as.beaconDB.HeadState(ctx)
+		headState, err = as.BeaconDB.HeadState(ctx)
 		if err != nil {
 			return nil, err
 		}
@@ -139,7 +154,7 @@ func (as *AttesterServer) RequestAttestation(ctx context.Context, req *pb.Attest
 		},
 	}
 
-	if err := as.attestationCache.Put(ctx, req, res); err != nil {
+	if err := as.AttestationCache.Put(ctx, req, res); err != nil {
 		return nil, err
 	}