Merge pull request #662 from onflow/gregor/node-version

Add GetNodeVersionInfo API
onflow · May 23, 2024 · 7bf794d · 7bf794d
2 parents 69778af + f9d5167
commit 7bf794d
Show file tree

Hide file tree

Showing 19 changed files with 373 additions and 44 deletions.
diff --git a/access/client.go b/access/client.go
@@ -40,6 +40,9 @@ type Client interface {
 	// GetNetworkParameters gets the network parameters.
 	GetNetworkParameters(ctx context.Context) (*flow.NetworkParameters, error)
 
+	// GetNodeVersionInfo gets the node information about the network.
+	GetNodeVersionInfo(ctx context.Context) (*flow.NodeVersionInfo, error)
+
 	// GetLatestBlockHeader gets the latest sealed or unsealed block header.
 	GetLatestBlockHeader(ctx context.Context, isSealed bool) (*flow.BlockHeader, error)
 

diff --git a/access/grpc/client.go b/access/grpc/client.go
@@ -115,6 +115,10 @@ func (c *Client) GetNetworkParameters(ctx context.Context) (*flow.NetworkParamet
 	return c.grpc.GetNetworkParameters(ctx)
 }
 
+func (c *Client) GetNodeVersionInfo(ctx context.Context) (*flow.NodeVersionInfo, error) {
+	return c.grpc.GetNodeVersionInfo(ctx)
+}
+
 func (c *Client) GetLatestBlockHeader(ctx context.Context, isSealed bool) (*flow.BlockHeader, error) {
 	return c.grpc.GetLatestBlockHeader(ctx, isSealed)
 }

diff --git a/access/grpc/grpc.go b/access/grpc/grpc.go
@@ -142,6 +142,23 @@ func (c *BaseClient) GetNetworkParameters(ctx context.Context, opts ...grpc.Call
 	}, nil
 }
 
+func (c *BaseClient) GetNodeVersionInfo(ctx context.Context, opts ...grpc.CallOption) (*flow.NodeVersionInfo, error) {
+	res, err := c.rpcClient.GetNodeVersionInfo(ctx, &access.GetNodeVersionInfoRequest{}, opts...)
+	if err != nil {
+		return nil, newRPCError(err)
+	}
+
+	info := res.GetInfo()
+	return &flow.NodeVersionInfo{
+		Semver:               info.Semver,
+		Commit:               info.Commit,
+		SporkId:              flow.BytesToID(info.SporkId),
+		ProtocolVersion:      info.ProtocolVersion,
+		SporkRootBlockHeight: info.SporkRootBlockHeight,
+		NodeRootBlockHeight:  info.NodeRootBlockHeight,
+	}, nil
+}
+
 func (c *BaseClient) GetLatestBlockHeader(
 	ctx context.Context,
 	isSealed bool,

diff --git a/access/grpc/grpc_test.go b/access/grpc/grpc_test.go
@@ -149,6 +149,41 @@ func TestClient_GetNetworkParameters(t *testing.T) {
 	}))
 }
 
+func TestClient_GetNodeInfo(t *testing.T) {
+	t.Run("Success", clientTest(func(t *testing.T, ctx context.Context, rpc *mocks.MockRPCClient, c *BaseClient) {
+		id := flow.HexToID("0x01")
+		ver := uint64(1)
+		spork := uint64(2)
+		root := uint64(3)
+
+		response := &access.GetNodeVersionInfoResponse{
+			Info: &entities.NodeVersionInfo{
+				Semver:               "1.0",
+				Commit:               "123",
+				SporkId:              id.Bytes(),
+				ProtocolVersion:      ver,
+				SporkRootBlockHeight: spork,
+				NodeRootBlockHeight:  root,
+			},
+		}
+
+		expected := &flow.NodeVersionInfo{
+			Semver:               "1.0",
+			Commit:               "123",
+			SporkId:              id,
+			ProtocolVersion:      ver,
+			SporkRootBlockHeight: spork,
+			NodeRootBlockHeight:  root,
+		}
+
+		rpc.On("GetNodeVersionInfo", ctx, mock.Anything).Return(response, nil)
+
+		info, err := c.GetNodeVersionInfo(ctx)
+		require.NoError(t, err)
+		require.Equal(t, expected, info)
+	}))
+}
+
 func TestClient_GetLatestBlockHeader(t *testing.T) {
 	blocks := test.BlockGenerator()
 

diff --git a/access/grpc/mocks/ExecutionDataRPCClient.go b/access/grpc/mocks/ExecutionDataRPCClient.go
diff --git a/access/http/client.go b/access/http/client.go
@@ -93,6 +93,10 @@ func (c *Client) GetNetworkParameters(ctx context.Context) (*flow.NetworkParamet
 	return c.httpClient.GetNetworkParameters(ctx)
 }
 
+func (c *Client) GetNodeVersionInfo(ctx context.Context) (*flow.NodeVersionInfo, error) {
+	return c.httpClient.GetNodeVersionInfo(ctx)
+}
+
 func (c *Client) GetBlockByID(ctx context.Context, blockID flow.Identifier) (*flow.Block, error) {
 	return c.httpClient.GetBlockByID(ctx, blockID)
 }

diff --git a/access/http/client_test.go b/access/http/client_test.go
@@ -25,6 +25,8 @@ import (
 	"testing"
 
 	jsoncdc "github.com/onflow/cadence/encoding/json"
+	"github.com/stretchr/testify/require"
+
 	"github.com/onflow/flow-go-sdk"
 	"github.com/onflow/flow-go-sdk/access/http/models"
 	"github.com/onflow/flow-go-sdk/test"
@@ -79,6 +81,29 @@ func TestClient_ClientOptions(t *testing.T) {
 	})
 }
 
+func TestBaseClient_GetNodeInfo(t *testing.T) {
+	t.Run("Success", clientTest(func(ctx context.Context, t *testing.T, handler *mockHandler, client *Client) {
+		httpInfo := &models.NodeVersionInfo{
+			Semver:               "1.0",
+			Commit:               "123",
+			SporkId:              flow.HexToID("0x01").String(),
+			ProtocolVersion:      "2",
+			SporkRootBlockHeight: "123",
+			NodeRootBlockHeight:  "321",
+		}
+		expectedInfo, err := toNodeVersionInfo(httpInfo)
+		require.NoError(t, err)
+
+		handler.
+			On("getNodeVersionInfo", mock.Anything).
+			Return(httpInfo, nil)
+
+		info, err := client.GetNodeVersionInfo(ctx)
+		require.NoError(t, err)
+		assert.Equal(t, expectedInfo, info)
+	}))
+}
+
 func TestBaseClient_GetNetworkParameters(t *testing.T) {
 	const handlerName = "getNetworkParameters"
 

diff --git a/access/http/convert.go b/access/http/convert.go
@@ -366,10 +366,10 @@ func toTransactionResult(txr *models.TransactionResult, options []cadenceJSON.Op
 	}
 
 	return &flow.TransactionResult{
-		Status:  toTransactionStatus(txr.Status),
-		Error:   txErr,
-		Events:  events,
-		BlockID: flow.HexToID(txr.BlockId),
+		Status:       toTransactionStatus(txr.Status),
+		Error:        txErr,
+		Events:       events,
+		BlockID:      flow.HexToID(txr.BlockId),
 		CollectionID: flow.HexToID(txr.CollectionId),
 	}, nil
 }
@@ -446,4 +446,28 @@ func toNetworkParameters(params *models.NetworkParameters) *flow.NetworkParamete
 	return &flow.NetworkParameters{
 		ChainID: flow.ChainID(params.ChainId),
 	}
-}
+}
+
+func toNodeVersionInfo(info *models.NodeVersionInfo) (*flow.NodeVersionInfo, error) {
+	version, err := strconv.ParseUint(info.ProtocolVersion, 10, 64)
+	if err != nil {
+		return nil, err
+	}
+	sporkHeight, err := strconv.ParseUint(info.SporkRootBlockHeight, 10, 64)
+	if err != nil {
+		return nil, err
+	}
+	nodeHeight, err := strconv.ParseUint(info.NodeRootBlockHeight, 10, 64)
+	if err != nil {
+		return nil, err
+	}
+
+	return &flow.NodeVersionInfo{
+		Semver:               info.Semver,
+		Commit:               info.Commit,
+		SporkId:              flow.HexToID(info.SporkId),
+		ProtocolVersion:      version,
+		SporkRootBlockHeight: sporkHeight,
+		NodeRootBlockHeight:  nodeHeight,
+	}, nil
+}
diff --git a/access/http/handler.go b/access/http/handler.go
@@ -180,6 +180,16 @@ func (h *httpHandler) getNetworkParameters(ctx context.Context, opts ...queryOpt
 	return &networkParameters, nil
 }
 
+func (h *httpHandler) getNodeVersionInfo(ctx context.Context, opts ...queryOpts) (*models.NodeVersionInfo, error) {
+	var nodeVersionInfo models.NodeVersionInfo
+	err := h.get(ctx, h.mustBuildURL("/node_version_info", opts...), &nodeVersionInfo)
+	if err != nil {
+		return nil, errors.Wrap(err, "get node version info failed")
+	}
+
+	return &nodeVersionInfo, nil
+}
+
 func (h *httpHandler) getBlockByID(ctx context.Context, ID string, opts ...queryOpts) (*models.Block, error) {
 	u := h.mustBuildURL(fmt.Sprintf("/blocks/%s", ID), opts...)
 

diff --git a/access/http/handler_test.go b/access/http/handler_test.go
@@ -28,6 +28,9 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/stretchr/testify/require"
+
+	"github.com/onflow/flow-go-sdk"
 	"github.com/onflow/flow-go-sdk/access/http/models"
 
 	"github.com/stretchr/testify/assert"
@@ -118,6 +121,33 @@ func TestHandler_ResponseFailures(t *testing.T) {
 	}))
 }
 
+func TestHandler_GetNodeVersionInfo(t *testing.T) {
+	t.Run("success", handlerTest(func(ctx context.Context, t *testing.T, handler httpHandler, req *testRequest) {
+		id := flow.HexToID("0x01")
+		sporkHeight := uint64(1337)
+		rootHeight := uint64(222)
+
+		httpInfo := &models.NodeVersionInfo{
+			Semver:               "1.0",
+			Commit:               "123",
+			SporkId:              id.String(),
+			ProtocolVersion:      "2.0",
+			SporkRootBlockHeight: fmt.Sprintf("%d", sporkHeight),
+			NodeRootBlockHeight:  fmt.Sprintf("%d", rootHeight),
+		}
+
+		u, err := url.Parse("/node_version_info")
+		require.NoError(t, err)
+
+		req.SetData(*u, httpInfo)
+
+		info, err := handler.getNodeVersionInfo(ctx)
+		require.NoError(t, err)
+		assert.Equal(t, httpInfo.SporkRootBlockHeight, info.SporkRootBlockHeight)
+		assert.Equal(t, httpInfo.SporkRootBlockHeight, info.SporkRootBlockHeight)
+	}))
+}
+
 func TestHandler_GetBlockByID(t *testing.T) {
 	t.Run("Success", handlerTest(func(ctx context.Context, t *testing.T, handler httpHandler, req *testRequest) {
 		b := blockFlowFixture()

diff --git a/access/http/http.go b/access/http/http.go
@@ -39,6 +39,7 @@ import (
 // handler interface defines methods needed to be offered by a specific http network implementation.
 type handler interface {
 	getNetworkParameters(ctx context.Context, opts ...queryOpts) (*models.NetworkParameters, error)
+	getNodeVersionInfo(ctx context.Context, opts ...queryOpts) (*models.NodeVersionInfo, error)
 	getBlockByID(ctx context.Context, ID string, opts ...queryOpts) (*models.Block, error)
 	getBlocksByHeights(ctx context.Context, heights string, startHeight string, endHeight string, opts ...queryOpts) ([]*models.Block, error)
 	getAccount(ctx context.Context, address string, height string, opts ...queryOpts) (*models.Account, error)
@@ -197,6 +198,15 @@ func (c *BaseClient) GetNetworkParameters(ctx context.Context) (*flow.NetworkPar
 	return toNetworkParameters(params), nil
 }
 
+func (c *BaseClient) GetNodeVersionInfo(ctx context.Context) (*flow.NodeVersionInfo, error) {
+	info, err := c.handler.getNodeVersionInfo(ctx)
+	if err != nil {
+		return nil, err
+	}
+
+	return toNodeVersionInfo(info)
+}
+
 func (c *BaseClient) GetBlockByID(ctx context.Context, blockID flow.Identifier, opts ...queryOpts) (*flow.Block, error) {
 	block, err := c.handler.getBlockByID(ctx, blockID.String())
 	if err != nil {

diff --git a/access/http/mock_handler.go b/access/http/mock_handler.go