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

package api

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

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

    EthApiName    = "eth"
    MergedApiName = "merged"
    MinerApiName  = "miner"
    NetApiName    = "net"
    Web3ApiName   = "web3"
)

// Ethereum RPC API interface
type EthereumApi interface {
    // API identifier
    Name() 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...)
}