rpc/api/api.go


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

package api

import (
    "strings"

    "github.com/ethereum/go-ethereum/rpc/shared"
)

const (
    AdminApiName    = "admin"
    EthApiName      = "eth"
    DebugApiName    = "debug"
    MergedApiName   = "merged"
    MinerApiName    = "miner"
    NetApiName      = "net"
    ShhApiName      = "shh"
    TxPoolApiName   = "txpool"
    PersonalApiName = "personal"
    Web3ApiName     = "web3"
)

var (
    // List with all API's which are offered over the IPC interface by default
    DefaultIpcApis = strings.Join([]string{
        AdminApiName, EthApiName, DebugApiName, MinerApiName, NetApiName,
        ShhApiName, TxPoolApiName, PersonalApiName, Web3ApiName,
    }, ",")
)

const (
    // List with all API's which are offered over the IPC interface by default
    DefaultIpcApis = "eth"
)

// 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 {
    return newMergedApi(apis...)
}