poc e2e grpc communication

Author: steezeburger

cmd/geth/config.go

@@ -172,6 +172,11 @@ func makeFullNode(ctx *cli.Context) (*node.Node, ethapi.Backend) {
 		utils.RegisterGraphQLService(stack, backend, filterSystem, &cfg.Node)
 	}
 
+	// Configure gRPC if requested.
+	if ctx.IsSet(utils.GRPCEnabledFlag.Name) {
+		utils.RegisterGRPCService(stack, backend, &cfg.Node)
+	}
+
 	// Add the Ethereum Stats daemon if requested.
 	if cfg.Ethstats.URL != "" {
 		utils.RegisterEthStatsService(stack, backend, cfg.Ethstats.URL)

cmd/geth/main.go

@@ -180,6 +180,9 @@ var (
 		utils.RPCGlobalEVMTimeoutFlag,
 		utils.RPCGlobalTxFeeCapFlag,
 		utils.AllowUnprotectedTxs,
+		utils.GRPCEnabledFlag,
+		utils.GRPCHostFlag,
+		utils.GRPCPortFlag,
 	}
 
 	metricsFlags = []cli.Flag{

cmd/utils/flags.go

@@ -791,6 +791,24 @@ var (
 		Usage:    "Enables the (deprecated) personal namespace",
 		Category: flags.APICategory,
 	}
+	// grpc
+	GRPCEnabledFlag = &cli.BoolFlag{
+		Name:     "grpc",
+		Usage:    "Enable the gRPC server",
+		Category: flags.APICategory,
+	}
+	GRPCHostFlag = &cli.StringFlag{
+		Name:     "grpc.addr",
+		Usage:    "gRPC server listening interface",
+		Value:    node.DefaultGRPCHost,
+		Category: flags.APICategory,
+	}
+	GRPCPortFlag = &cli.IntFlag{
+		Name:     "grpc.port",
+		Usage:    "gRPC server listening port",
+		Value:    node.DefaultGRPCPort,
+		Category: flags.APICategory,
+	}
 
 	// Network Settings
 	MaxPeersFlag = &cli.IntFlag{
@@ -1211,6 +1229,19 @@ func setHTTP(ctx *cli.Context, cfg *node.Config) {
 	}
 }
 
+// setGRCP creates the gRPC RPC listener interface string from the set command
+// line flags, returning empty if the gRPC endpoint is disabled.
+func setGRCP(ctx *cli.Context, cfg *node.Config) {
+	if ctx.Bool(GRPCEnabledFlag.Name) && cfg.GRPCHost == "" {
+		if ctx.IsSet(GRPCHostFlag.Name) {
+			cfg.GRPCHost = ctx.String(GRPCHostFlag.Name)
+		}
+		if ctx.IsSet(GRPCPortFlag.Name) {
+			cfg.GRPCPort = ctx.Int(GRPCPortFlag.Name)
+		}
+	}
+}
+
 // setGraphQL creates the GraphQL listener interface string from the set
 // command line flags, returning empty if the GraphQL endpoint is disabled.
 func setGraphQL(ctx *cli.Context, cfg *node.Config) {
@@ -1460,6 +1491,7 @@ func SetNodeConfig(ctx *cli.Context, cfg *node.Config) {
 	SetP2PConfig(ctx, &cfg.P2P)
 	setIPC(ctx, cfg)
 	setHTTP(ctx, cfg)
+	setGRCP(ctx, cfg)
 	setGraphQL(ctx, cfg)
 	setWS(ctx, cfg)
 	setNodeUserIdent(ctx, cfg)
@@ -2032,6 +2064,14 @@ func RegisterGraphQLService(stack *node.Node, backend ethapi.Backend, filterSyst
 	}
 }
 
+// RegisterGRPCService adds the gRPC API to the node.
+// It was done this way so that our grpc execution server can access the ethapi.Backend
+func RegisterGRPCService(stack *node.Node, backend ethapi.Backend, cfg *node.Config) {
+	if err := node.NewGRPCServerHandler(stack, backend, cfg); err != nil {
+		Fatalf("Failed to register the gRPC service: %v", err)
+	}
+}
+
 // RegisterFilterAPI adds the eth log filtering RPC API to the node.
 func RegisterFilterAPI(stack *node.Node, backend ethapi.Backend, ethcfg *ethconfig.Config) *filters.FilterSystem {
 	isLightClient := ethcfg.SyncMode == downloader.LightSync

grpc/README.md

@@ -0,0 +1,15 @@
+This package provides a gRPC server as an entrypoint to the EVM.
+
+Helpful commands (MacOS):
+```bash
+# install necessary dependencies
+brew install leveldb
+
+# build geth
+make geth
+
+# TODO - run beacon?
+
+# run geth
+./build/bin/geth --http.api eth,web3,net,txpool --ws --ws.api eth,web3,net,txpool --grpc --grpc.addr="https://[::1]" --grpc.port 50051
+```

grpc/execution/server.go

@@ -7,12 +7,13 @@ package execution
 import (
 	"context"
 
+	"github.com/ethereum/go-ethereum/core/types"
 	executionv1 "github.com/ethereum/go-ethereum/grpc/gen/proto/execution/v1"
-	"google.golang.org/grpc"
+	"github.com/ethereum/go-ethereum/internal/ethapi"
 )
 
 // executionServiceServer is the implementation of the ExecutionServiceServer interface.
-type executionServiceServer struct {
+type ExecutionServiceServer struct {
 	// NOTE - from the generated code:
 	// All implementations must embed UnimplementedExecutionServiceServer
 	// for forward compatibility
@@ -21,23 +22,42 @@ type executionServiceServer struct {
 	// TODO - will need access to the consensus api to call functions for building a block
 	// e.g. getPayload, newPayload, forkchoiceUpdated
 
+	Backend ethapi.Backend
+
 	// TODO - will need access to forkchoice on first run.
 	// this will probably be passed in when calling NewServer
 }
 
 // FIXME - how do we know which hash to start with? will probably need another api function like
 // GetHeadHash() to get the head hash of the forkchoice
 
-func (s *executionServiceServer) DoBlock(ctx context.Context, req *executionv1.DoBlockRequest) (*executionv1.DoBlockResponse, error) {
-	// Request.Header.ParentHash needs to match forkchoice head hash
+func (s *ExecutionServiceServer) DoBlock(ctx context.Context, req *executionv1.DoBlockRequest) (*executionv1.DoBlockResponse, error) {
+	print("DoBlock called")
+
+	// NOTE - Request.Header.ParentHash needs to match forkchoice head hash
 	// ParentHash should be the forkchoice head of the last block
 
 	// TODO - need to call consensus api to build a block
-	return nil, nil
+
+	txs := bytesToTransactions(req.Transactions)
+	for _, tx := range txs {
+		s.Backend.SendTx(ctx, tx)
+	}
+
+	res := &executionv1.DoBlockResponse{
+		// TODO - get state root from last block
+		StateRoot: []byte{0x00},
+	}
+	return res, nil
 }
 
-func NewServer() *grpc.Server {
-	server := grpc.NewServer()
-	executionv1.RegisterExecutionServiceServer(server, &executionServiceServer{})
-	return server
+// convert bytes to transactions
+func bytesToTransactions(b [][]byte) []*types.Transaction {
+	txs := []*types.Transaction{}
+	for _, txBytes := range b {
+		tx := &types.Transaction{}
+		tx.UnmarshalBinary(txBytes)
+		txs = append(txs, tx)
+	}
+	return txs
 }

node/config.go

@@ -189,6 +189,12 @@ type Config struct {
 	// Requests using ip address directly are not affected
 	GraphQLVirtualHosts []string `toml:",omitempty"`
 
+	// GRPCHost is the host interface on which to start the gRPC server. If this
+	// field is empty, no gRPC API endpoint will be started.
+	GRPCHost string `toml:",omitempty"`
+	// GRPCPort is the TCP port number on which to start the gRPC server.
+	GRPCPort int `toml:",omitempty"`
+
 	// Logger is a custom logger to use with the p2p.Server.
 	Logger log.Logger `toml:",omitempty"`
 
@@ -260,12 +266,29 @@ func (c *Config) HTTPEndpoint() string {
 	return fmt.Sprintf("%s:%d", c.HTTPHost, c.HTTPPort)
 }
 
+// GRPCEndpoint resolves a gRPC endpoint based on the configured host interface
+// and port parameters.
+func (c *Config) GRPCEndpoint() string {
+	if c.GRPCHost == "" {
+		return ""
+	}
+	return fmt.Sprintf("%s:%d", c.GRPCHost, c.GRPCPort)
+}
+
 // DefaultHTTPEndpoint returns the HTTP endpoint used by default.
 func DefaultHTTPEndpoint() string {
 	config := &Config{HTTPHost: DefaultHTTPHost, HTTPPort: DefaultHTTPPort, AuthPort: DefaultAuthPort}
 	return config.HTTPEndpoint()
 }
 
+// DefaultGRPCEndpoint returns the gRPC endpoint used by default.
+// NOTE - implemented this to be consistent with DefaultHTTPEndpoint, but
+// neither are ever used
+func DefaultGRPCEndpoint() string {
+	config := &Config{GRPCHost: DefaultGRPCHost, GRPCPort: DefaultGRPCPort}
+	return config.GRPCEndpoint()
+}
+
 // WSEndpoint resolves a websocket endpoint based on the configured host interface
 // and port parameters.
 func (c *Config) WSEndpoint() string {

node/defaults.go

@@ -36,6 +36,9 @@ const (
 	DefaultGraphQLPort = 8547        // Default TCP port for the GraphQL server
 	DefaultAuthHost    = "localhost" // Default host interface for the authenticated apis
 	DefaultAuthPort    = 8551        // Default port for the authenticated apis
+	// grpc
+	DefaultGRPCHost = "[::1]" // Default host interface for the gRPC server
+	DefaultGRPCPort = 50051   // Default port for the gRPC server
 )
 
 var (
@@ -65,6 +68,9 @@ var DefaultConfig = Config{
 		NAT:        nat.Any(),
 	},
 	DBEngine: "",
+	// grpc
+	GRPCHost: DefaultGRPCHost,
+	GRPCPort: DefaultGRPCPort,
 }
 
 // DefaultDataDir is the default data directory to use for the databases and other

node/grpcstack.go

@@ -0,0 +1,66 @@
+package node
+
+import (
+	"net"
+
+	"github.com/ethereum/go-ethereum/grpc/execution"
+	executionv1 "github.com/ethereum/go-ethereum/grpc/gen/proto/execution/v1"
+	"github.com/ethereum/go-ethereum/internal/ethapi"
+	"github.com/ethereum/go-ethereum/log"
+	"google.golang.org/grpc"
+)
+
+// GRPCServerHandler is the gRPC server handler.
+// It gives us a way to attach the gRPC server to the node so it can be stopped on shutdown.
+type GRPCServerHandler struct {
+	endpoint               string
+	server                 *grpc.Server
+	executionServiceServer *execution.ExecutionServiceServer
+}
+
+// NewServer creates a new gRPC server.
+// It registers the execution service server.
+// It registers the gRPC server with the node so it can be stopped on shutdown.
+func NewGRPCServerHandler(node *Node, backend ethapi.Backend, cfg *Config) error {
+	server := grpc.NewServer()
+
+	executionServiceServer := &execution.ExecutionServiceServer{
+		Backend: backend,
+	}
+
+	log.Info("gRPC server enabled", "endpoint", cfg.GRPCEndpoint())
+
+	serverHandler := &GRPCServerHandler{
+		endpoint:               cfg.GRPCEndpoint(),
+		server:                 server,
+		executionServiceServer: executionServiceServer,
+	}
+
+	executionv1.RegisterExecutionServiceServer(server, executionServiceServer)
+
+	node.RegisterGRPCServer(serverHandler)
+	return nil
+}
+
+// Start starts the gRPC server if it is enabled.
+func (handler *GRPCServerHandler) Start() error {
+	if handler.endpoint == "" {
+		return nil
+	}
+
+	// Start the gRPC server
+	lis, err := net.Listen("tcp", handler.endpoint)
+	if err != nil {
+		return err
+	}
+	go handler.server.Serve(lis)
+	log.Info("gRPC server started", "endpoint", handler.endpoint)
+	return nil
+}
+
+// Stop stops the gRPC server.
+func (handler *GRPCServerHandler) Stop() error {
+	handler.server.Stop()
+	log.Info("gRPC server stopped", "endpoint", handler.endpoint)
+	return nil
+}

node/node.go

@@ -64,6 +64,9 @@ type Node struct {
 	ipc           *ipcServer  // Stores information about the ipc http server
 	inprocHandler *rpc.Server // In-process RPC request handler to process the API requests
 
+	// grpc
+	grpcServerHandler *GRPCServerHandler // Stores information about the grpc server
+
 	databases map[*closeTrackingDB]struct{} // All open databases
 }
 
@@ -274,6 +277,11 @@ func (n *Node) openEndpoints() error {
 		n.stopRPC()
 		n.server.Stop()
 	}
+	// start GRPC endpoints
+	err = n.startGRPC()
+	if err != nil {
+		n.stopGRPC()
+	}
 	return err
 }
 
@@ -521,6 +529,21 @@ func (n *Node) stopRPC() {
 	n.stopInProc()
 }
 
+func (n *Node) startGRPC() error {
+	if n.config.GRPCHost != "" {
+		// start the server
+		if err := n.grpcServerHandler.Start(); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func (n *Node) stopGRPC() {
+	n.grpcServerHandler.Stop()
+}
+
 // startInProc registers all RPC APIs on the inproc server.
 func (n *Node) startInProc(apis []rpc.API) error {
 	for _, api := range apis {
@@ -588,6 +611,19 @@ func (n *Node) getAPIs() (unauthenticated, all []rpc.API) {
 	return unauthenticated, n.rpcAPIs
 }
 
+// RegisterGRPCServer registers a gRPC server on the node.
+// This allows us to control grpc server startup and shutdown from the node.
+func (n *Node) RegisterGRPCServer(handler *GRPCServerHandler) {
+	n.lock.Lock()
+	defer n.lock.Unlock()
+
+	if n.state != initializingState {
+		panic("can't register gRPC server on running/stopped node")
+	}
+
+	n.grpcServerHandler = handler
+}
+
 // RegisterHandler mounts a handler on the given path on the canonical HTTP server.
 //
 // The name of the handler is shown in a log message when the HTTP server starts
@@ -667,6 +703,11 @@ func (n *Node) HTTPEndpoint() string {
 	return "http://" + n.http.listenAddr()
 }
 
+// GRPCENDPOINT returns the URL of the GRPC server.
+func (n *Node) GRPCEndpoint() string {
+	return "http://" + n.grpcServerHandler.endpoint
+}
+
 // WSEndpoint returns the current JSON-RPC over WebSocket endpoint.
 func (n *Node) WSEndpoint() string {
 	if n.http.wsAllowed() {