feat(dot/rpc): implement sync_state_genSyncSpec RPC call

chain/dev/config.toml

@@ -35,5 +35,5 @@ enabled = true
 ws = true
 port = 8545
 host = "localhost"
-modules = ["system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate"]
+modules = ["system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate", "syncstate"]
 ws-port = 8546

chain/dev/defaults.go

@@ -87,7 +87,7 @@ var (
 	// DefaultRPCHTTPPort rpc port
 	DefaultRPCHTTPPort = uint32(8545)
 	// DefaultRPCModules rpc modules
-	DefaultRPCModules = []string{"system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate"}
+	DefaultRPCModules = []string{"system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate", "syncstate"}
 	// DefaultRPCWSPort rpc websocket port
 	DefaultRPCWSPort = uint32(8546)
 	// DefaultRPCEnabled enables the RPC server

chain/gssmr/config.toml

@@ -35,5 +35,5 @@ discovery-interval = 10
 enabled = false
 port = 8545
 host = "localhost"
-modules = ["system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate"]
+modules = ["system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate", "syncstate"]
 ws-port = 8546

chain/gssmr/defaults.go

@@ -92,7 +92,7 @@ var (
 	// DefaultRPCHTTPPort rpc port
 	DefaultRPCHTTPPort = uint32(8545)
 	// DefaultRPCModules rpc modules
-	DefaultRPCModules = []string{"system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate"}
+	DefaultRPCModules = []string{"system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate", "syncstate"}
 	// DefaultRPCWSPort rpc websocket port
 	DefaultRPCWSPort = uint32(8546)
 )

chain/kusama/config.toml

@@ -35,7 +35,7 @@ enabled = false
 external = false
 port = 8545
 host = "localhost"
-modules = ["system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate"]
+modules = ["system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate", "syncstate"]
 ws-port = 8546
 ws = false
 ws-external = false

chain/kusama/defaults.go

@@ -83,7 +83,7 @@ var (
 	// DefaultRPCHTTPPort rpc port
 	DefaultRPCHTTPPort = uint32(8545)
 	// DefaultRPCModules rpc modules
-	DefaultRPCModules = []string{"system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate"}
+	DefaultRPCModules = []string{"system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate", "syncstate"}
 	// DefaultRPCWSPort rpc websocket port
 	DefaultRPCWSPort = uint32(8546)
 )

chain/polkadot/config.toml

@@ -34,5 +34,5 @@ nomdns = false
 enabled = false
 port = 8545
 host = "localhost"
-modules = ["system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate"]
+modules = ["system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate", "syncstate"]
 ws-port = 8546

chain/polkadot/defaults.go

@@ -84,7 +84,7 @@ var (
 	// DefaultRPCHTTPPort rpc port
 	DefaultRPCHTTPPort = uint32(8545)
 	// DefaultRPCModules rpc modules
-	DefaultRPCModules = []string{"system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate"}
+	DefaultRPCModules = []string{"system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate", "syncstate"}
 	// DefaultRPCWSPort rpc websocket port
 	DefaultRPCWSPort = uint32(8546)
 )

dot/rpc/http.go

@@ -54,6 +54,7 @@ type HTTPServerConfig struct {
 	TransactionQueueAPI modules.TransactionStateAPI
 	RPCAPI              modules.RPCAPI
 	SystemAPI           modules.SystemAPI
+	SyncStateAPI        modules.SyncStateAPI
 	NodeStorage         *runtime.NodeStorage
 	RPC                 bool
 	RPCExternal         bool
@@ -129,13 +130,14 @@ func (h *HTTPServer) RegisterModules(mods []string) {
 			srvc = modules.NewOffchainModule(h.serverConfig.NodeStorage)
 		case "childstate":
 			srvc = modules.NewChildStateModule(h.serverConfig.StorageAPI, h.serverConfig.BlockAPI)
+		case "syncstate":
+			srvc = modules.NewSyncStateModule(h.serverConfig.SyncStateAPI)
 		default:
 			h.logger.Warn("Unrecognised module", "module", mod)
 			continue
 		}
 
 		err := h.rpcServer.RegisterService(srvc, mod)
-
 		if err != nil {
 			h.logger.Warn("Failed to register module", "mod", mod, "err", err)
 		}

dot/rpc/http_test.go

@@ -41,7 +41,7 @@ import (
 func TestRegisterModules(t *testing.T) {
 	rpcapiMocks := new(mocks.MockRPCAPI)
 
-	mods := []string{"system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate"}
+	mods := []string{"system", "author", "chain", "state", "rpc", "grandpa", "offchain", "childstate", "syncstate"}
 
 	for _, modName := range mods {
 		rpcapiMocks.On("BuildMethodNames", mock.Anything, modName).Once()
@@ -125,7 +125,7 @@ func TestNewHTTPServer(t *testing.T) {
 
 func TestUnsafeRPCProtection(t *testing.T) {
 	cfg := &HTTPServerConfig{
-		Modules:           []string{"system", "author", "chain", "state", "rpc", "grandpa", "dev"},
+		Modules:           []string{"system", "author", "chain", "state", "rpc", "grandpa", "dev", "syncstate"},
 		RPCPort:           7878,
 		RPCAPI:            NewService(),
 		RPCUnsafe:         false,

dot/rpc/modules/api.go

@@ -9,6 +9,7 @@ import (
 	"github.com/ChainSafe/gossamer/lib/common"
 	"github.com/ChainSafe/gossamer/lib/crypto"
 	"github.com/ChainSafe/gossamer/lib/crypto/ed25519"
+	"github.com/ChainSafe/gossamer/lib/genesis"
 	"github.com/ChainSafe/gossamer/lib/grandpa"
 	"github.com/ChainSafe/gossamer/lib/runtime"
 	"github.com/ChainSafe/gossamer/lib/transaction"
@@ -121,3 +122,7 @@ type RuntimeStorageAPI interface {
 	GetLocal(k []byte) ([]byte, error)
 	GetPersistent(k []byte) ([]byte, error)
 }
+
+type SyncStateAPI interface {
+	GenSyncSpec(raw bool) (*genesis.Genesis, error)
+}

dot/rpc/modules/sync_state.go

@@ -0,0 +1,80 @@
+// Copyright 2019 ChainSafe Systems (ON) Corp.
+// This file is part of gossamer.
+//
+// The gossamer library is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// The gossamer library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with the gossamer library. If not, see <http://www.gnu.org/licenses/>.
+
+package modules
+
+import (
+	"encoding/json"
+	"io/ioutil"
+	"net/http"
+	"path/filepath"
+
+	"github.com/ChainSafe/gossamer/lib/genesis"
+)
+
+type SyncStateModule struct {
+	SyncStateAPI SyncStateAPI
+}
+
+type BoolRequest struct {
+	Raw bool
+}
+
+func NewSyncStateModule(s SyncStateAPI) *SyncStateModule {
+	return &SyncStateModule{SyncStateAPI: s}
+}
+
+func (ss *SyncStateModule) GenSyncSpec(_ *http.Request, req *BoolRequest, res *genesis.Genesis) error {
+	genesis, err := ss.SyncStateAPI.GenSyncSpec(req.Raw)
+	if err != nil {
+		return err
+	}
+
+	*res = *genesis
+	return nil
+}
+
+type SyncState struct {
+	GenesisFilePath string
+}
+
+// GenSyncSpec returns the JSON serialized chain specification running the node
+// (i.e. the current state), with a sync state.
+func (s SyncState) GenSyncSpec(raw bool) (*genesis.Genesis, error) {
+	fp, err := filepath.Abs(s.GenesisFilePath)
+	if err != nil {
+		return nil, err
+	}
+	data, err := ioutil.ReadFile(filepath.Clean(fp))
+	if err != nil {
+		return nil, err
+	}
+
+	g := new(genesis.Genesis)
+	err = json.Unmarshal(data, g)
+	if err != nil {
+		return nil, err
+	}
+
+	if raw {
+		err = g.ToRaw()
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	return g, nil
+}

dot/rpc/modules/sync_state_test.go

@@ -0,0 +1,22 @@
+package modules
+
+import (
+	"testing"
+
+	"github.com/ChainSafe/gossamer/lib/genesis"
+	"github.com/stretchr/testify/require"
+)
+
+const GssmrGenesisPath = "../../../chain/gssmr/genesis.json"
+
+func TestSyncStateModule(t *testing.T) {
+	module := NewSyncStateModule(SyncState{GenesisFilePath: GssmrGenesisPath})
+
+	req := BoolRequest{
+		Raw: true,
+	}
+	var res genesis.Genesis
+
+	err := module.GenSyncSpec(nil, &req, &res)
+	require.NoError(t, err)
+}

dot/rpc/service.go

@@ -49,7 +49,7 @@ var (
 )
 
 // BuildMethodNames takes receiver interface and populates rpcMethods array with available
-//  method names
+// method names
 func (s *Service) BuildMethodNames(rcvr interface{}, name string) {
 	rcvrType := reflect.TypeOf(rcvr)
 	for i := 0; i < rcvrType.NumMethod(); i++ {

dot/services.go

@@ -346,6 +346,7 @@ func createRPCService(cfg *Config, ns *runtime.NodeStorage, stateSrvc *state.Ser
 		BlockFinalityAPI:    finSrvc,
 		TransactionQueueAPI: stateSrvc.Transaction,
 		RPCAPI:              rpcService,
+		SyncStateAPI:        modules.SyncState{GenesisFilePath: cfg.Init.Genesis},
 		SystemAPI:           sysSrvc,
 		RPC:                 cfg.RPC.Enabled,
 		RPCExternal:         cfg.RPC.External,

tests/data/db/config.toml

@@ -34,5 +34,5 @@ nomdns = false
 enabled = false
 port = 8545
 host = "localhost"
-modules = ["system", "author", "chain", "state", "rpc", "grandpa"]
+modules = ["system", "author", "chain", "state", "rpc", "grandpa", "syncstate"]
 ws-port = 8546