plugeth/rpc/api/api.go

49 lines
1.0 KiB
Go
Raw Normal View History

2015-06-08 08:23:54 +00:00
package api
2015-06-09 08:59:44 +00:00
import (
"strings"
"github.com/ethereum/go-ethereum/rpc/shared"
)
2015-06-08 08:23:54 +00:00
2015-06-08 09:01:02 +00:00
const (
2015-06-09 14:06:51 +00:00
AdminApiName = "admin"
2015-06-09 08:59:44 +00:00
EthApiName = "eth"
DebugApiName = "debug"
MergedApiName = "merged"
MinerApiName = "miner"
NetApiName = "net"
2015-06-10 10:35:12 +00:00
ShhApiName = "shh"
TxPoolApiName = "txpool"
2015-06-09 08:59:44 +00:00
PersonalApiName = "personal"
Web3ApiName = "web3"
)
var (
2015-06-08 09:01:02 +00:00
// List with all API's which are offered over the IPC interface by default
2015-06-09 08:59:44 +00:00
DefaultIpcApis = strings.Join([]string{
2015-06-10 10:35:12 +00:00
AdminApiName, EthApiName, DebugApiName, MinerApiName, NetApiName,
ShhApiName, TxPoolApiName, PersonalApiName, Web3ApiName,
2015-06-09 08:59:44 +00:00
}, ",")
2015-06-08 09:01:02 +00:00
)
2015-06-08 08:23:54 +00:00
// Ethereum RPC API interface
type EthereumApi interface {
2015-06-08 10:43:58 +00:00
// API identifier
Name() string
2015-06-08 08:23:54 +00:00
// API version
ApiVersion() string
2015-06-08 08:23:54 +00:00
// 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
}
2015-06-08 10:43:58 +00:00
// Merge multiple API's to a single API instance
func Merge(apis ...EthereumApi) EthereumApi {
return newMergedApi(apis...)
}