github.com/bamzi/go-ethereum@v1.6.7-0.20170704111104-138f26c93af1/internal/ethapi/backend.go (about)

     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  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     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  // GNU Lesser General Public License for more details.
    13  //
    14  // 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  
    17  // Package ethapi implements the general Ethereum API functions.
    18  package ethapi
    19  
    20  import (
    21  	"context"
    22  	"math/big"
    23  
    24  	"github.com/ethereum/go-ethereum/accounts"
    25  	"github.com/ethereum/go-ethereum/common"
    26  	"github.com/ethereum/go-ethereum/core"
    27  	"github.com/ethereum/go-ethereum/core/state"
    28  	"github.com/ethereum/go-ethereum/core/types"
    29  	"github.com/ethereum/go-ethereum/core/vm"
    30  	"github.com/ethereum/go-ethereum/eth/downloader"
    31  	"github.com/ethereum/go-ethereum/ethdb"
    32  	"github.com/ethereum/go-ethereum/event"
    33  	"github.com/ethereum/go-ethereum/params"
    34  	"github.com/ethereum/go-ethereum/rpc"
    35  )
    36  
    37  // Backend interface provides the common API services (that are provided by
    38  // both full and light clients) with access to necessary functions.
    39  type Backend interface {
    40  	// general Ethereum API
    41  	Downloader() *downloader.Downloader
    42  	ProtocolVersion() int
    43  	SuggestPrice(ctx context.Context) (*big.Int, error)
    44  	ChainDb() ethdb.Database
    45  	EventMux() *event.TypeMux
    46  	AccountManager() *accounts.Manager
    47  	// BlockChain API
    48  	SetHead(number uint64)
    49  	HeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Header, error)
    50  	BlockByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Block, error)
    51  	StateAndHeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*state.StateDB, *types.Header, error)
    52  	GetBlock(ctx context.Context, blockHash common.Hash) (*types.Block, error)
    53  	GetReceipts(ctx context.Context, blockHash common.Hash) (types.Receipts, error)
    54  	GetTd(blockHash common.Hash) *big.Int
    55  	GetEVM(ctx context.Context, msg core.Message, state *state.StateDB, header *types.Header, vmCfg vm.Config) (*vm.EVM, func() error, error)
    56  
    57  	// TxPool API
    58  	SendTx(ctx context.Context, signedTx *types.Transaction) error
    59  	RemoveTx(txHash common.Hash)
    60  	GetPoolTransactions() (types.Transactions, error)
    61  	GetPoolTransaction(txHash common.Hash) *types.Transaction
    62  	GetPoolNonce(ctx context.Context, addr common.Address) (uint64, error)
    63  	Stats() (pending int, queued int)
    64  	TxPoolContent() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
    65  
    66  	ChainConfig() *params.ChainConfig
    67  	CurrentBlock() *types.Block
    68  }
    69  
    70  func GetAPIs(apiBackend Backend) []rpc.API {
    71  	nonceLock := new(AddrLocker)
    72  	return []rpc.API{
    73  		{
    74  			Namespace: "eth",
    75  			Version:   "1.0",
    76  			Service:   NewPublicEthereumAPI(apiBackend),
    77  			Public:    true,
    78  		}, {
    79  			Namespace: "eth",
    80  			Version:   "1.0",
    81  			Service:   NewPublicBlockChainAPI(apiBackend),
    82  			Public:    true,
    83  		}, {
    84  			Namespace: "eth",
    85  			Version:   "1.0",
    86  			Service:   NewPublicTransactionPoolAPI(apiBackend, nonceLock),
    87  			Public:    true,
    88  		}, {
    89  			Namespace: "txpool",
    90  			Version:   "1.0",
    91  			Service:   NewPublicTxPoolAPI(apiBackend),
    92  			Public:    true,
    93  		}, {
    94  			Namespace: "debug",
    95  			Version:   "1.0",
    96  			Service:   NewPublicDebugAPI(apiBackend),
    97  			Public:    true,
    98  		}, {
    99  			Namespace: "debug",
   100  			Version:   "1.0",
   101  			Service:   NewPrivateDebugAPI(apiBackend),
   102  		}, {
   103  			Namespace: "eth",
   104  			Version:   "1.0",
   105  			Service:   NewPublicAccountAPI(apiBackend.AccountManager()),
   106  			Public:    true,
   107  		}, {
   108  			Namespace: "personal",
   109  			Version:   "1.0",
   110  			Service:   NewPrivateAccountAPI(apiBackend, nonceLock),
   111  			Public:    false,
   112  		},
   113  	}
   114  }