cometbft · thanethomson · Aug 1, 2023 · Jul 6, 2023 · Jul 7, 2023 · Jul 7, 2023
diff --git a/.changelog/unreleased/features/1094-grpc-block-service-cfg.md b/.changelog/unreleased/features/1094-grpc-block-service-cfg.md
@@ -0,0 +1,2 @@
+- `[config]` Add `[grpc.block_service]` section to configure gRPC `BlockService`
+  ([\#1094](https://github.com/cometbft/cometbft/issues/1094))
diff --git a/.changelog/unreleased/features/1094-grpc-block-service.md b/.changelog/unreleased/features/1094-grpc-block-service.md
@@ -0,0 +1,3 @@
+- `[grpc]` Add `BlockService` with client to facilitate fetching of blocks and
+  streaming of the latest committed block height
+  ([\#1094](https://github.com/cometbft/cometbft/issues/1094))
diff --git a/config/config.go b/config/config.go
@@ -520,19 +520,24 @@ type GRPCConfig struct {
 	// The gRPC version service provides version information about the node and
 	// the protocols it uses.
 	VersionService *GRPCVersionServiceConfig `mapstructure:"version_service"`
+
+	// The gRPC block service provides block information
+	BlockService *GRPCBlockServiceConfig `mapstructure:"block_service"`
 }
 
 func DefaultGRPCConfig() *GRPCConfig {
 	return &GRPCConfig{
 		ListenAddress:  "",
 		VersionService: DefaultGRPCVersionServiceConfig(),
+		BlockService:   DefaultGRPCBlockServiceConfig(),
 	}
 }
 
 func TestGRPCConfig() *GRPCConfig {
 	return &GRPCConfig{
 		ListenAddress:  "tcp://127.0.0.1:36670",
 		VersionService: TestGRPCVersionServiceConfig(),
+		BlockService:   TestGRPCBlockServiceConfig(),
 	}
 }
 
@@ -565,6 +570,22 @@ func TestGRPCVersionServiceConfig() *GRPCVersionServiceConfig {
 	}
 }
 
+type GRPCBlockServiceConfig struct {
+	Enabled bool `mapstructure:"enabled"`
+}
+
+func DefaultGRPCBlockServiceConfig() *GRPCBlockServiceConfig {
+	return &GRPCBlockServiceConfig{
+		Enabled: true,
+	}
+}
+
+func TestGRPCBlockServiceConfig() *GRPCBlockServiceConfig {
+	return &GRPCBlockServiceConfig{
+		Enabled: true,
+	}
+}
+
 //-----------------------------------------------------------------------------
 // P2PConfig
 

diff --git a/config/toml.go b/config/toml.go
@@ -276,6 +276,10 @@ laddr = "{{ .GRPC.ListenAddress }}"
 [grpc.version_service]
 enabled = {{ .GRPC.VersionService.Enabled }}
 
+# The gRPC block service returns block information
+[grpc.block_service]
+enabled = {{ .GRPC.BlockService.Enabled }}
+
 #######################################################
 ###           P2P Configuration Options             ###
 #######################################################

diff --git a/docs/core/configuration.md b/docs/core/configuration.md
@@ -38,7 +38,7 @@ version = "0.39.0"
 proxy_app = "tcp://127.0.0.1:26658"
 
 # A custom human readable name for this node
-moniker = "anonymous"
+moniker = "thinkpad"
 
 # Database backend: goleveldb | cleveldb | boltdb | rocksdb | badgerdb
 # * goleveldb (github.com/syndtr/goleveldb - most popular implementation)
@@ -65,7 +65,7 @@ db_backend = "goleveldb"
 db_dir = "data"
 
 # Output level for logging, including package level options
-log_level = "main:info,state:info,statesync:info,*:error"
+log_level = "info"
 
 # Output format: 'plain' (colored text) or 'json'
 log_format = "plain"
@@ -130,12 +130,12 @@ unsafe = false
 # 1024 - 40 - 10 - 50 = 924 = ~900
 max_open_connections = 900
 
-# Maximum number of unique clientIDs that can /subscribe
+# Maximum number of unique clientIDs that can /subscribe.
 # If you're using /broadcast_tx_commit, set to the estimated maximum number
 # of broadcast_tx_commit calls per block.
 max_subscription_clients = 100
 
-# Maximum number of unique queries a given client can /subscribe to
+# Maximum number of unique queries a given client can /subscribe to.
 # If you're using /broadcast_tx_commit, set to the estimated maximum number
 # of broadcast_tx_commit calls per block.
 max_subscriptions_per_client = 5
@@ -197,6 +197,40 @@ tls_key_file = ""
 # pprof listen address (https://golang.org/pkg/net/http/pprof)
 pprof_laddr = ""
 
+#######################################################
+###       gRPC Server Configuration Options         ###
+#######################################################
+
+#
+# Note that the gRPC server is exposed unauthenticated. It is critical that
+# this server not be exposed directly to the public internet. If this service
+# must be accessed via the public internet, please ensure that appropriate
+# precautions are taken (e.g. fronting with a reverse proxy like nginx with TLS
+# termination and authentication, using DDoS protection services like
+# CloudFlare, etc.).
+#
+
+[grpc]
+
+# TCP or UNIX socket address for the RPC server to listen on. If not specified,
+# the gRPC server will be disabled.
+laddr = ""
+
+#
+# Each gRPC service can be turned on/off, and in some cases configured,
+# individually. If the gRPC server is not enabled, all individual services'
+# configurations are ignored.
+#
+
+# The gRPC version service provides version information about the node and the
+# protocols it uses.
+[grpc.version_service]
+enabled = true
+
+# The gRPC block service returns block information
+[grpc.block_service]
+enabled = true
+
 #######################################################
 ###           P2P Configuration Options             ###
 #######################################################
@@ -404,6 +438,7 @@ create_empty_blocks_interval = "0s"
 
 # Reactor sleep duration parameters
 peer_gossip_sleep_duration = "100ms"
+peer_gossip_intraloop_sleep_duration = "0s"
 peer_query_maj23_sleep_duration = "2s"
 
 #######################################################

diff --git a/internal/rpctrace/rpctrace.go b/internal/rpctrace/rpctrace.go
@@ -0,0 +1,13 @@
+package rpctrace
+
+import "github.com/gofrs/uuid"
+
+// New returns a randomly generated string which can be used to assist in
+// tracing RPC errors.
+func New() (string, error) {
+	id, err := uuid.NewV4()
+	if err != nil {
+		return "", err
+	}
+	return id.String(), nil
+}
diff --git a/node/node.go b/node/node.go
@@ -626,6 +626,9 @@ func (n *Node) startRPC() ([]net.Listener, error) {
 		if n.config.GRPC.VersionService.Enabled {
 			opts = append(opts, grpcserver.WithVersionService())
 		}
+		if n.config.GRPC.BlockService.Enabled {
+			opts = append(opts, grpcserver.WithBlockService(n.blockStore, n.eventBus, n.Logger))
+		}
 		go func() {
 			if err := grpcserver.Serve(listener, opts...); err != nil {
 				n.Logger.Error("Error starting gRPC server", "err", err)

diff --git a/proto/buf.yaml b/proto/buf.yaml
@@ -8,4 +8,3 @@ lint:
   use:
     - BASIC
     - FILE_LOWER_SNAKE_CASE
-    - UNARY_RPC