added RPC start/stop support

Author: Bas van Kervel

cmd/geth/js.go

@@ -41,6 +41,7 @@ import (
 	"github.com/ethereum/go-ethereum/xeth"
 	"github.com/peterh/liner"
 	"github.com/robertkrimen/otto"
+	"github.com/ethereum/go-ethereum/rpc/shared"
 )
 
 type prompter interface {
@@ -183,7 +184,9 @@ func newJSRE(ethereum *eth.Ethereum, libPath, corsDomain string, client comms.Et
 	js.wait = js.xeth.UpdateState()
 	js.client = client
 	if clt, ok := js.client.(*comms.InProcClient); ok {
-		clt.Initialize(js.xeth, ethereum)
+		if offeredApis, err := api.ParseApiString(shared.AllApis, codec.JSON, js.xeth, ethereum); err == nil {
+			clt.Initialize(api.Merge(offeredApis...))
+		}
 	}
 
 	// update state in separare forever blocks
@@ -311,7 +314,7 @@ func (js *jsre) apiBindings(f xeth.Frontend) error {
 	// load only supported API's in javascript runtime
 	shortcuts := "var eth = web3.eth; "
 	for _, apiName := range apiNames {
-		if apiName == api.Web3ApiName || apiName == api.EthApiName {
+		if apiName == shared.Web3ApiName || apiName == shared.EthApiName {
 			continue // manually mapped
 		}
 

cmd/geth/js_test.go

@@ -210,7 +210,7 @@ func TestRPC(t *testing.T) {
 	defer ethereum.Stop()
 	defer os.RemoveAll(tmp)
 
-	checkEvalJSON(t, repl, `admin.startRPC("127.0.0.1", 5004)`, `true`)
+	checkEvalJSON(t, repl, `admin.startRPC("127.0.0.1", 5004, "*", "web3,eth,net")`, `true`)
 }
 
 func TestCheckTestAccountBalance(t *testing.T) {

cmd/utils/flags.go

@@ -461,7 +461,7 @@ func StartIPC(eth *eth.Ethereum, ctx *cli.Context) error {
 		return err
 	}
 
-	return comms.StartIpc(config, codec, apis...)
+	return comms.StartIpc(config, codec, api.Merge(apis...))
 }
 
 func StartRPC(eth *eth.Ethereum, ctx *cli.Context) error {
@@ -479,7 +479,7 @@ func StartRPC(eth *eth.Ethereum, ctx *cli.Context) error {
 		return err
 	}
 
-	return comms.StartHttp(config, codec, apis...)
+	return comms.StartHttp(config, codec, api.Merge(apis...))
 }
 
 func StartPProf(ctx *cli.Context) {

rpc/api/admin.go

@@ -11,6 +11,7 @@ import (
 	"github.com/ethereum/go-ethereum/logger/glog"
 	"github.com/ethereum/go-ethereum/rlp"
 	"github.com/ethereum/go-ethereum/rpc/codec"
+	"github.com/ethereum/go-ethereum/rpc/comms"
 	"github.com/ethereum/go-ethereum/rpc/shared"
 	"github.com/ethereum/go-ethereum/xeth"
 )
@@ -32,6 +33,8 @@ var (
 		"admin_chainSyncStatus": (*adminApi).ChainSyncStatus,
 		"admin_setSolc":         (*adminApi).SetSolc,
 		"admin_datadir":         (*adminApi).DataDir,
+		"admin_startRPC":        (*adminApi).StartRPC,
+		"admin_stopRPC":         (*adminApi).StopRPC,
 	}
 )
 
@@ -42,25 +45,25 @@ type adminhandler func(*adminApi, *shared.Request) (interface{}, error)
 type adminApi struct {
 	xeth     *xeth.XEth
 	ethereum *eth.Ethereum
-	methods  map[string]adminhandler
-	codec    codec.ApiCoder
+	codec    codec.Codec
+	coder    codec.ApiCoder
 }
 
 // create a new admin api instance
-func NewAdminApi(xeth *xeth.XEth, ethereum *eth.Ethereum, coder codec.Codec) *adminApi {
+func NewAdminApi(xeth *xeth.XEth, ethereum *eth.Ethereum, codec codec.Codec) *adminApi {
 	return &adminApi{
 		xeth:     xeth,
 		ethereum: ethereum,
-		methods:  AdminMapping,
-		codec:    coder.New(nil),
+		codec:    codec,
+		coder:    codec.New(nil),
 	}
 }
 
 // collection with supported methods
 func (self *adminApi) Methods() []string {
-	methods := make([]string, len(self.methods))
+	methods := make([]string, len(AdminMapping))
 	i := 0
-	for k := range self.methods {
+	for k := range AdminMapping {
 		methods[i] = k
 		i++
 	}
@@ -69,15 +72,15 @@ func (self *adminApi) Methods() []string {
 
 // Execute given request
 func (self *adminApi) Execute(req *shared.Request) (interface{}, error) {
-	if callback, ok := self.methods[req.Method]; ok {
+	if callback, ok := AdminMapping[req.Method]; ok {
 		return callback(self, req)
 	}
 
 	return nil, &shared.NotImplementedError{req.Method}
 }
 
 func (self *adminApi) Name() string {
-	return AdminApiName
+	return shared.AdminApiName
 }
 
 func (self *adminApi) ApiVersion() string {
@@ -86,7 +89,7 @@ func (self *adminApi) ApiVersion() string {
 
 func (self *adminApi) AddPeer(req *shared.Request) (interface{}, error) {
 	args := new(AddPeerArgs)
-	if err := self.codec.Decode(req.Params, &args); err != nil {
+	if err := self.coder.Decode(req.Params, &args); err != nil {
 		return nil, shared.NewDecodeParamError(err.Error())
 	}
 
@@ -120,7 +123,7 @@ func hasAllBlocks(chain *core.ChainManager, bs []*types.Block) bool {
 
 func (self *adminApi) ImportChain(req *shared.Request) (interface{}, error) {
 	args := new(ImportExportChainArgs)
-	if err := self.codec.Decode(req.Params, &args); err != nil {
+	if err := self.coder.Decode(req.Params, &args); err != nil {
 		return nil, shared.NewDecodeParamError(err.Error())
 	}
 
@@ -163,7 +166,7 @@ func (self *adminApi) ImportChain(req *shared.Request) (interface{}, error) {
 
 func (self *adminApi) ExportChain(req *shared.Request) (interface{}, error) {
 	args := new(ImportExportChainArgs)
-	if err := self.codec.Decode(req.Params, &args); err != nil {
+	if err := self.coder.Decode(req.Params, &args); err != nil {
 		return nil, shared.NewDecodeParamError(err.Error())
 	}
 
@@ -181,7 +184,7 @@ func (self *adminApi) ExportChain(req *shared.Request) (interface{}, error) {
 
 func (self *adminApi) Verbosity(req *shared.Request) (interface{}, error) {
 	args := new(VerbosityArgs)
-	if err := self.codec.Decode(req.Params, &args); err != nil {
+	if err := self.coder.Decode(req.Params, &args); err != nil {
 		return nil, shared.NewDecodeParamError(err.Error())
 	}
 
@@ -202,7 +205,7 @@ func (self *adminApi) ChainSyncStatus(req *shared.Request) (interface{}, error)
 
 func (self *adminApi) SetSolc(req *shared.Request) (interface{}, error) {
 	args := new(SetSolcArgs)
-	if err := self.codec.Decode(req.Params, &args); err != nil {
+	if err := self.coder.Decode(req.Params, &args); err != nil {
 		return nil, shared.NewDecodeParamError(err.Error())
 	}
 
@@ -212,3 +215,32 @@ func (self *adminApi) SetSolc(req *shared.Request) (interface{}, error) {
 	}
 	return solc.Info(), nil
 }
+
+func (self *adminApi) StartRPC(req *shared.Request) (interface{}, error) {
+	var err error
+	args := new(StartRPCArgs)
+	if err := self.coder.Decode(req.Params, &args); err != nil {
+		return nil, shared.NewDecodeParamError(err.Error())
+	}
+
+	cfg := comms.HttpConfig{
+		ListenAddress: args.ListenAddress,
+		ListenPort:    args.ListenPort,
+		CorsDomain:    args.CorsDomain,
+	}
+
+	if apis, err := ParseApiString(args.Apis, self.codec, self.xeth, self.ethereum); err == nil {
+		err = comms.StartHttp(cfg, self.codec, Merge(apis...))
+	}
+
+	if err == nil {
+		return true, nil
+	}
+
+	return false, err
+}
+
+func (self *adminApi) StopRPC(req *shared.Request) (interface{}, error) {
+	comms.StopHttp()
+	return true, nil
+}

rpc/api/admin_args.go

@@ -95,3 +95,55 @@ func (args *SetSolcArgs) UnmarshalJSON(b []byte) (err error) {
 
 	return shared.NewInvalidTypeError("path", "not a string")
 }
+
+type StartRPCArgs struct {
+	ListenAddress string
+	ListenPort    uint
+	CorsDomain    string
+	Apis          string
+}
+
+func (args *StartRPCArgs) UnmarshalJSON(b []byte) (err error) {
+	var obj []interface{}
+	if err := json.Unmarshal(b, &obj); err != nil {
+		return shared.NewDecodeParamError(err.Error())
+	}
+
+	args.ListenAddress = "127.0.0.1"
+	args.ListenPort = 8545
+	args.Apis = "net,eth,web3"
+
+	if len(obj) >= 1 {
+		if addr, ok := obj[0].(string); ok {
+			args.ListenAddress = addr
+		} else {
+			return shared.NewInvalidTypeError("listenAddress", "not a string")
+		}
+	}
+
+	if len(obj) >= 2 {
+		if port, ok := obj[1].(float64); ok && port >= 0 && port <= 64*1024 {
+			args.ListenPort = uint(port)
+		} else {
+			return shared.NewInvalidTypeError("listenPort", "not a valid port number")
+		}
+	}
+
+	if len(obj) >= 3 {
+		if corsDomain, ok := obj[2].(string); ok {
+			args.CorsDomain = corsDomain
+		} else {
+			return shared.NewInvalidTypeError("corsDomain", "not a string")
+		}
+	}
+
+	if len(obj) >= 4 {
+		if apis, ok := obj[3].(string); ok {
+			args.Apis = apis
+		} else {
+			return shared.NewInvalidTypeError("apis", "not a string")
+		}
+	}
+
+	return nil
+}

rpc/api/admin_js.go

@@ -39,6 +39,20 @@ web3._extend({
 			params: 1,
 			inputFormatter: [web3._extend.utils.formatInputString],
 			outputFormatter: web3._extend.formatters.formatOutputString
+		}),
+		new web3._extend.Method({
+			name: 'startRPC',
+			call: 'admin_startRPC',
+			params: 4,
+			inputFormatter: [web3._extend.utils.formatInputString,web3._extend.utils.formatInputInteger,web3._extend.utils.formatInputString,web3._extend.utils.formatInputString],
+			outputFormatter: web3._extend.formatters.formatOutputBool
+		}),
+		new web3._extend.Method({
+			name: 'stopRPC',
+			call: 'admin_stopRPC',
+			params: 0,
+			inputFormatter: [],
+			outputFormatter: web3._extend.formatters.formatOutputBool
 		})
 	],
 	properties:

rpc/api/api.go

@@ -1,51 +1,10 @@
 package api
 
 import (
-	"strings"
-
 	"github.com/ethereum/go-ethereum/rpc/shared"
 )
 
-const (
-	AdminApiName    = "admin"
-	EthApiName      = "eth"
-	DbApiName       = "db"
-	DebugApiName    = "debug"
-	MergedApiName   = "merged"
-	MinerApiName    = "miner"
-	NetApiName      = "net"
-	ShhApiName      = "shh"
-	TxPoolApiName   = "txpool"
-	PersonalApiName = "personal"
-	Web3ApiName     = "web3"
-
-	JsonRpcVersion = "2.0"
-)
-
-var (
-	// All API's
-	AllApis = strings.Join([]string{
-		AdminApiName, DbApiName, EthApiName, DebugApiName, MinerApiName, NetApiName,
-		ShhApiName, TxPoolApiName, PersonalApiName, Web3ApiName,
-	}, ",")
-)
-
-// Ethereum RPC API interface
-type EthereumApi interface {
-	// API identifier
-	Name() string
-
-	// API version
-	ApiVersion() string
-
-	// Execute the given request and returns the response or an error
-	Execute(*shared.Request) (interface{}, error)
-
-	// List of supported RCP methods this API provides
-	Methods() []string
-}
-
 // Merge multiple API's to a single API instance
-func Merge(apis ...EthereumApi) EthereumApi {
+func Merge(apis ...shared.EthereumApi) shared.EthereumApi {
 	return newMergedApi(apis...)
 }

rpc/api/args.go

@@ -2,6 +2,7 @@ package api
 
 import (
 	"encoding/json"
+
 	"github.com/ethereum/go-ethereum/rpc/shared"
 )
 
@@ -54,4 +55,4 @@ func (args *FilterStringArgs) UnmarshalJSON(b []byte) (err error) {
 	}
 	args.Word = argstr
 	return nil
-}
+}

rpc/api/args_test.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"math/big"
 	"testing"
+
 	"github.com/ethereum/go-ethereum/rpc/shared"
 )
 

rpc/api/db.go

@@ -63,7 +63,7 @@ func (self *dbApi) Execute(req *shared.Request) (interface{}, error) {
 }
 
 func (self *dbApi) Name() string {
-	return DbApiName
+	return shared.DbApiName
 }
 
 func (self *dbApi) ApiVersion() string {