github.com/Blockdaemon/celo-blockchain@v0.0.0-20200129231733-e667f6b08419/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  	SuggestPriceInCurrency(ctx context.Context, currencyAddress *common.Address) (*big.Int, error)
    45  	ChainDb() ethdb.Database
    46  	EventMux() *event.TypeMux
    47  	AccountManager() *accounts.Manager
    48  
    49  	// BlockChain API
    50  	SetHead(number uint64)
    51  	HeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Header, error)
    52  	BlockByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Block, error)
    53  	StateAndHeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*state.StateDB, *types.Header, error)
    54  	GetBlock(ctx context.Context, blockHash common.Hash) (*types.Block, error)
    55  	GetReceipts(ctx context.Context, blockHash common.Hash) (types.Receipts, error)
    56  	GetTd(blockHash common.Hash) *big.Int
    57  	GetEVM(ctx context.Context, msg vm.Message, header *types.Header, state *state.StateDB) (*vm.EVM, func() error, error)
    58  	SubscribeChainEvent(ch chan<- core.ChainEvent) event.Subscription
    59  	SubscribeChainHeadEvent(ch chan<- core.ChainHeadEvent) event.Subscription
    60  	SubscribeChainSideEvent(ch chan<- core.ChainSideEvent) event.Subscription
    61  
    62  	// TxPool API
    63  	SendTx(ctx context.Context, signedTx *types.Transaction) error
    64  	GetPoolTransactions() (types.Transactions, error)
    65  	GetPoolTransaction(txHash common.Hash) *types.Transaction
    66  	GetPoolNonce(ctx context.Context, addr common.Address) (uint64, error)
    67  	Stats() (pending int, queued int)
    68  	TxPoolContent() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
    69  	SubscribeNewTxsEvent(chan<- core.NewTxsEvent) event.Subscription
    70  
    71  	ChainConfig() *params.ChainConfig
    72  	CurrentBlock() *types.Block
    73  
    74  	GatewayFeeRecipient() common.Address
    75  	GatewayFee() *big.Int
    76  }
    77  
    78  func GetAPIs(apiBackend Backend) []rpc.API {
    79  	nonceLock := new(AddrLocker)
    80  	return []rpc.API{
    81  		{
    82  			Namespace: "eth",
    83  			Version:   "1.0",
    84  			Service:   NewPublicEthereumAPI(apiBackend),
    85  			Public:    true,
    86  		}, {
    87  			Namespace: "eth",
    88  			Version:   "1.0",
    89  			Service:   NewPublicBlockChainAPI(apiBackend),
    90  			Public:    true,
    91  		}, {
    92  			Namespace: "eth",
    93  			Version:   "1.0",
    94  			Service:   NewPublicTransactionPoolAPI(apiBackend, nonceLock),
    95  			Public:    true,
    96  		}, {
    97  			Namespace: "txpool",
    98  			Version:   "1.0",
    99  			Service:   NewPublicTxPoolAPI(apiBackend),
   100  			Public:    true,
   101  		}, {
   102  			Namespace: "debug",
   103  			Version:   "1.0",
   104  			Service:   NewPublicDebugAPI(apiBackend),
   105  			Public:    true,
   106  		}, {
   107  			Namespace: "debug",
   108  			Version:   "1.0",
   109  			Service:   NewPrivateDebugAPI(apiBackend),
   110  		}, {
   111  			Namespace: "eth",
   112  			Version:   "1.0",
   113  			Service:   NewPublicAccountAPI(apiBackend.AccountManager()),
   114  			Public:    true,
   115  		}, {
   116  			Namespace: "personal",
   117  			Version:   "1.0",
   118  			Service:   NewPrivateAccountAPI(apiBackend, nonceLock),
   119  			Public:    false,
   120  		},
   121  	}
   122  }