mergedapi.go 2.41 KB
Newer Older
1
// Copyright 2015 The go-ethereum Authors
2
// This file is part of the go-ethereum library.
3
//
4
// The go-ethereum library is free software: you can redistribute it and/or modify
5 6 7 8
// 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.
//
9
// The go-ethereum library is distributed in the hope that it will be useful,
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 13 14
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
15
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
16

Bas van Kervel's avatar
Bas van Kervel committed
17 18
package api

Bas van Kervel's avatar
Bas van Kervel committed
19
import (
Bas van Kervel's avatar
Bas van Kervel committed
20 21
	"github.com/ethereum/go-ethereum/logger"
	"github.com/ethereum/go-ethereum/logger/glog"
Bas van Kervel's avatar
Bas van Kervel committed
22 23 24 25 26 27
	"github.com/ethereum/go-ethereum/rpc/shared"
)

const (
	MergedApiVersion = "1.0"
)
Bas van Kervel's avatar
Bas van Kervel committed
28 29

// combines multiple API's
Bas van Kervel's avatar
Bas van Kervel committed
30
type MergedApi struct {
Bas van Kervel's avatar
Bas van Kervel committed
31
	apis    map[string]string
32
	methods map[string]shared.EthereumApi
Bas van Kervel's avatar
Bas van Kervel committed
33 34 35
}

// create new merged api instance
36
func newMergedApi(apis ...shared.EthereumApi) *MergedApi {
Bas van Kervel's avatar
Bas van Kervel committed
37
	mergedApi := new(MergedApi)
Bas van Kervel's avatar
Bas van Kervel committed
38
	mergedApi.apis = make(map[string]string, len(apis))
39
	mergedApi.methods = make(map[string]shared.EthereumApi)
Bas van Kervel's avatar
Bas van Kervel committed
40

Bas van Kervel's avatar
Bas van Kervel committed
41
	for _, api := range apis {
42 43 44 45 46
		if api != nil {
			mergedApi.apis[api.Name()] = api.ApiVersion()
			for _, method := range api.Methods() {
				mergedApi.methods[method] = api
			}
Bas van Kervel's avatar
Bas van Kervel committed
47 48 49 50 51 52
		}
	}
	return mergedApi
}

// Supported RPC methods
Bas van Kervel's avatar
Bas van Kervel committed
53
func (self *MergedApi) Methods() []string {
Bas van Kervel's avatar
Bas van Kervel committed
54 55 56 57 58 59 60 61
	all := make([]string, len(self.methods))
	for method, _ := range self.methods {
		all = append(all, method)
	}
	return all
}

// Call the correct API's Execute method for the given request
Bas van Kervel's avatar
Bas van Kervel committed
62
func (self *MergedApi) Execute(req *shared.Request) (interface{}, error) {
63
	glog.V(logger.Detail).Infof("%s %s", req.Method, req.Params)
Bas van Kervel's avatar
Bas van Kervel committed
64

Bas van Kervel's avatar
Bas van Kervel committed
65 66 67 68 69 70 71 72 73
	if res, _ := self.handle(req); res != nil {
		return res, nil
	}
	if api, found := self.methods[req.Method]; found {
		return api.Execute(req)
	}
	return nil, shared.NewNotImplementedError(req.Method)
}

Bas van Kervel's avatar
Bas van Kervel committed
74
func (self *MergedApi) Name() string {
75
	return shared.MergedApiName
Bas van Kervel's avatar
Bas van Kervel committed
76 77
}

Bas van Kervel's avatar
Bas van Kervel committed
78 79 80 81
func (self *MergedApi) ApiVersion() string {
	return MergedApiVersion
}

Bas van Kervel's avatar
Bas van Kervel committed
82
func (self *MergedApi) handle(req *shared.Request) (interface{}, error) {
Bas van Kervel's avatar
Bas van Kervel committed
83
	if req.Method == "modules" { // provided API's
Bas van Kervel's avatar
Bas van Kervel committed
84 85 86 87 88
		return self.apis, nil
	}

	return nil, nil
}