feat(jsonrpc): add operation to get Node info like its chain ID, version, and default block

Author: renatomaia

internal/jsonrpc/api/response.go

@@ -20,3 +20,9 @@ type ListResponse[T any] struct {
 type SingleResponse[T any] struct {
 	Data T `json:"data"`
 }
+
+type NodeInfo struct {
+	ChainID      string `json:"chain_id"`
+	Version      string `json:"version"`
+	DefaultBlock string `json:"default_block"` // FINALIZED | SAFE | LATEST | PENDING
+}

internal/jsonrpc/jsonrpc-discover.json

@@ -1365,10 +1365,31 @@
 				}
 			]
 		},
+		{
+			"name": "cartesi_getNodeInfo",
+			"summary": "Get node information",
+			"description": "Fetches the chain ID, semantic node version, and default blockchain block tag used by the node.",
+			"params": [],
+			"result": {
+				"name": "result",
+				"schema": {
+					"$ref": "#/components/schemas/NodeInfoResult"
+				}
+			},
+			"errors": [
+				{
+					"$ref": "#/components/errors/NodeConfigNotFound"
+				},
+				{
+					"$ref": "#/components/errors/InternalError"
+				}
+			]
+		},
 		{
 			"name": "cartesi_getChainId",
 			"summary": "Get node's chain ID",
 			"description": "Fetches the chain ID that node is operating on.",
+			"deprecated": true,
 			"params": [],
 			"result": {
 				"name": "result",
@@ -1389,6 +1410,7 @@
 			"name": "cartesi_getNodeVersion",
 			"summary": "Get node version",
 			"description": "Fetches the semantic version of the Cartesi rollups node.",
+			"deprecated": true,
 			"params": [],
 			"result": {
 				"name": "result",
@@ -2156,6 +2178,36 @@
 					}
 				}
 			},
+			"NodeInfo": {
+				"type": "object",
+				"properties": {
+					"chain_id": {
+						"$ref": "#/components/schemas/UnsignedInteger"
+					},
+					"version": {
+						"type": "string",
+						"format": "semver",
+						"pattern": "^[a-zA-Z0-9_-\\.]+$"
+					},
+					"default_block": {
+						"type": "string",
+						"enum": [
+							"FINALIZED",
+							"SAFE",
+							"LATEST",
+							"PENDING"
+						]
+					}
+				}
+			},
+			"NodeInfoResult": {
+				"type": "object",
+				"properties": {
+					"data": {
+						"$ref": "#/components/schemas/NodeInfo"
+					}
+				}
+			},
 			"NodeVersionResult": {
 				"type": "object",
 				"properties": {

internal/jsonrpc/jsonrpc.go

@@ -80,6 +80,7 @@ var jsonrpcHandlers = dispatchTable{
 	"cartesi_getMatch":                  handleGetMatch,
 	"cartesi_listMatchAdvances":         handleListMatchAdvances,
 	"cartesi_getMatchAdvanced":          handleGetMatchAdvanced,
+	"cartesi_getNodeInfo":               handleGetNodeInfo,
 	"cartesi_getChainId":                handleGetChainID,
 	"cartesi_getNodeVersion":            handleGetNodeVersion,
 }
@@ -1359,6 +1360,23 @@ func handleGetMatchAdvanced(s *Service, r *http.Request, req RPCRequest) (any, e
 	return api.SingleResponse[*model.MatchAdvanced]{Data: matchAdvanced}, nil
 }
 
+func handleGetNodeInfo(s *Service, r *http.Request, _ RPCRequest) (any, error) {
+	cfg, err := repository.LoadNodeConfig[evmreader.PersistentConfig](r.Context(), s.repository, evmreader.EvmReaderConfigKey)
+	if errors.Is(err, repository.ErrNotFound) {
+		return nil, newRPCError(JSONRPC_RESOURCE_NOT_FOUND, "EVM Reader config not found")
+	}
+	if err != nil {
+		s.Logger.Error("Unable to retrieve evmreader config from repository", "err", err)
+		return nil, newRPCError(JSONRPC_INTERNAL_ERROR, "Internal server error")
+	}
+
+	return api.SingleResponse[api.NodeInfo]{Data: api.NodeInfo{
+		ChainID:      fmt.Sprintf("0x%x", cfg.Value.ChainID),
+		Version:      version.BuildVersion,
+		DefaultBlock: string(cfg.Value.DefaultBlock), // FINALIZED | SAFE | LATEST | PENDING
+	}}, nil
+}
+
 func handleGetChainID(s *Service, r *http.Request, _ RPCRequest) (any, error) {
 	config, err := repository.LoadNodeConfig[evmreader.PersistentConfig](r.Context(), s.repository, evmreader.EvmReaderConfigKey)
 	if errors.Is(err, repository.ErrNotFound) {

internal/jsonrpc/jsonrpc_test.go

@@ -159,6 +159,66 @@ func TestMethod(t *testing.T) {
 		})
 	})
 
+	////////////////////////////////////////////////////////////////////////
+	// getNodeInfo
+	////////////////////////////////////////////////////////////////////////
+	t.Run("cartesi_getNodeInfo", func(t *testing.T) {
+		method := getName(t.Name())
+
+		// failure: evm reader not configured -> resource not found
+		t.Run("absent", func(t *testing.T) {
+			testHistogram.inc(method)
+			s := newTestService(t, t.Name())
+
+			body := s.doRequest(t, 0, []byte(`{
+				"jsonrpc": "2.0",
+				"method": "cartesi_getNodeInfo",
+				"params": {},
+				"id": 0
+			}`))
+
+			resp := testRPCResponse[any]{}
+			require.NoError(t, json.Unmarshal(body, &resp))
+			require.NotNil(t, resp.Error)
+			assert.Equal(t, JSONRPC_RESOURCE_NOT_FOUND, resp.Error.Code)
+			assert.Equal(t, "EVM Reader config not found", resp.Error.Message)
+		})
+
+		// success: combine persisted node configuration with the build version
+		t.Run("present", func(t *testing.T) {
+			testHistogram.inc(method)
+			ctx := context.Background()
+			s := newTestService(t, t.Name())
+
+			chainID := uint64(0xdeadbeef)
+			defaultBlock := model.DefaultBlock_Safe
+			err := repository.SaveNodeConfig(ctx, s.repository,
+				&model.NodeConfig[evmreader.PersistentConfig]{
+					Key: evmreader.EvmReaderConfigKey,
+					Value: evmreader.PersistentConfig{
+						ChainID:      chainID,
+						DefaultBlock: defaultBlock,
+					},
+				},
+			)
+			require.NoError(t, err)
+
+			body := s.doRequest(t, 0, []byte(`{
+				"jsonrpc": "2.0",
+				"method": "cartesi_getNodeInfo",
+				"params": {},
+				"id": 0
+			}`))
+
+			resp := testRPCResponse[api.NodeInfo]{}
+			require.NoError(t, json.Unmarshal(body, &resp))
+			require.Nil(t, resp.Error)
+			assert.Equal(t, hexutil.EncodeUint64(chainID), resp.Result.Data.ChainID)
+			assert.Equal(t, version.BuildVersion, resp.Result.Data.Version)
+			assert.Equal(t, string(defaultBlock), resp.Result.Data.DefaultBlock)
+		})
+	})
+
 	////////////////////////////////////////////////////////////////////////
 	// getChainId
 	////////////////////////////////////////////////////////////////////////