2016-11-08 19:01:56 -06:00
|
|
|
// Copyright 2015 The go-ethereum Authors
|
2015-12-15 21:26:23 -06:00
|
|
|
// This file is part of the go-ethereum library.
|
|
|
|
//
|
|
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
|
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
// GNU Lesser General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
// Package ethapi implements the general Ethereum API functions.
|
|
|
|
package ethapi
|
|
|
|
|
|
|
|
import (
|
2017-03-22 12:20:33 -05:00
|
|
|
"context"
|
2015-12-15 21:26:23 -06:00
|
|
|
"math/big"
|
|
|
|
|
|
|
|
"github.com/ethereum/go-ethereum/accounts"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
|
|
"github.com/ethereum/go-ethereum/core"
|
2019-06-12 03:24:24 -05:00
|
|
|
"github.com/ethereum/go-ethereum/core/bloombits"
|
2017-06-27 08:57:06 -05:00
|
|
|
"github.com/ethereum/go-ethereum/core/state"
|
2015-12-15 21:26:23 -06:00
|
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
|
|
"github.com/ethereum/go-ethereum/core/vm"
|
|
|
|
"github.com/ethereum/go-ethereum/eth/downloader"
|
|
|
|
"github.com/ethereum/go-ethereum/ethdb"
|
|
|
|
"github.com/ethereum/go-ethereum/event"
|
2016-11-02 07:44:13 -05:00
|
|
|
"github.com/ethereum/go-ethereum/params"
|
2015-12-15 21:26:23 -06:00
|
|
|
"github.com/ethereum/go-ethereum/rpc"
|
|
|
|
)
|
|
|
|
|
|
|
|
// Backend interface provides the common API services (that are provided by
|
|
|
|
// both full and light clients) with access to necessary functions.
|
|
|
|
type Backend interface {
|
2017-11-13 05:47:27 -06:00
|
|
|
// General Ethereum API
|
2015-12-15 21:26:23 -06:00
|
|
|
Downloader() *downloader.Downloader
|
|
|
|
ProtocolVersion() int
|
|
|
|
SuggestPrice(ctx context.Context) (*big.Int, error)
|
|
|
|
ChainDb() ethdb.Database
|
|
|
|
AccountManager() *accounts.Manager
|
2019-04-04 06:03:10 -05:00
|
|
|
ExtRPCEnabled() bool
|
2020-06-17 02:46:31 -05:00
|
|
|
RPCTxFeeCap() float64 // global tx fee cap for all transaction related APIs
|
2020-07-01 12:54:21 -05:00
|
|
|
RPCGasCap() uint64 // global gas cap for eth_call over rpc: DoS protection
|
2017-11-13 05:47:27 -06:00
|
|
|
|
2019-06-12 03:24:24 -05:00
|
|
|
// Blockchain API
|
2015-12-15 21:26:23 -06:00
|
|
|
SetHead(number uint64)
|
2019-07-23 08:52:24 -05:00
|
|
|
HeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Header, error)
|
|
|
|
HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)
|
2019-09-26 03:47:31 -05:00
|
|
|
HeaderByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*types.Header, error)
|
2019-07-23 08:52:24 -05:00
|
|
|
BlockByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Block, error)
|
2019-07-25 01:29:53 -05:00
|
|
|
BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)
|
2019-09-26 03:47:31 -05:00
|
|
|
BlockByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*types.Block, error)
|
2019-07-23 08:52:24 -05:00
|
|
|
StateAndHeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*state.StateDB, *types.Header, error)
|
2019-09-26 03:47:31 -05:00
|
|
|
StateAndHeaderByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*state.StateDB, *types.Header, error)
|
2019-07-23 08:52:24 -05:00
|
|
|
GetReceipts(ctx context.Context, hash common.Hash) (types.Receipts, error)
|
2020-07-13 04:02:54 -05:00
|
|
|
GetTd(ctx context.Context, hash common.Hash) *big.Int
|
core, internal, eth, miner, les: Take VM config from BlockChain (#17955)
Until this commit, when sending an RPC request that called `NewEVM`, a blank `vm.Config`
would be taken so as to set some options, based on the default configuration. If some extra
configuration switches were passed to the blockchain, those would be ignored.
This PR adds a function to get the config from the blockchain, and this is what is now used
for RPC calls.
Some subsequent changes need to be made, see https://github.com/ethereum/go-ethereum/pull/17955#pullrequestreview-182237244
for the details of the discussion.
2018-12-06 07:34:49 -06:00
|
|
|
GetEVM(ctx context.Context, msg core.Message, state *state.StateDB, header *types.Header) (*vm.EVM, func() error, error)
|
2017-08-18 05:58:36 -05:00
|
|
|
SubscribeChainEvent(ch chan<- core.ChainEvent) event.Subscription
|
|
|
|
SubscribeChainHeadEvent(ch chan<- core.ChainHeadEvent) event.Subscription
|
|
|
|
SubscribeChainSideEvent(ch chan<- core.ChainSideEvent) event.Subscription
|
2017-06-27 08:57:06 -05:00
|
|
|
|
2019-06-12 03:24:24 -05:00
|
|
|
// Transaction pool API
|
2015-12-15 21:26:23 -06:00
|
|
|
SendTx(ctx context.Context, signedTx *types.Transaction) error
|
2019-05-13 06:41:10 -05:00
|
|
|
GetTransaction(ctx context.Context, txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64, error)
|
2016-12-10 16:54:58 -06:00
|
|
|
GetPoolTransactions() (types.Transactions, error)
|
2015-12-15 21:26:23 -06:00
|
|
|
GetPoolTransaction(txHash common.Hash) *types.Transaction
|
|
|
|
GetPoolNonce(ctx context.Context, addr common.Address) (uint64, error)
|
|
|
|
Stats() (pending int, queued int)
|
2016-07-01 10:59:55 -05:00
|
|
|
TxPoolContent() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
|
2018-05-18 03:45:52 -05:00
|
|
|
SubscribeNewTxsEvent(chan<- core.NewTxsEvent) event.Subscription
|
2016-11-02 07:44:13 -05:00
|
|
|
|
2019-06-12 03:24:24 -05:00
|
|
|
// Filter API
|
|
|
|
BloomStatus() (uint64, uint64)
|
|
|
|
GetLogs(ctx context.Context, blockHash common.Hash) ([][]*types.Log, error)
|
|
|
|
ServiceFilter(ctx context.Context, session *bloombits.MatcherSession)
|
|
|
|
SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription
|
2019-12-10 05:39:14 -06:00
|
|
|
SubscribePendingLogsEvent(ch chan<- []*types.Log) event.Subscription
|
2019-06-12 03:24:24 -05:00
|
|
|
SubscribeRemovedLogsEvent(ch chan<- core.RemovedLogsEvent) event.Subscription
|
|
|
|
|
2016-11-02 07:44:13 -05:00
|
|
|
ChainConfig() *params.ChainConfig
|
|
|
|
CurrentBlock() *types.Block
|
2015-12-15 21:26:23 -06:00
|
|
|
}
|
|
|
|
|
2017-04-12 16:04:14 -05:00
|
|
|
func GetAPIs(apiBackend Backend) []rpc.API {
|
2017-05-25 10:08:13 -05:00
|
|
|
nonceLock := new(AddrLocker)
|
2017-03-15 20:54:52 -05:00
|
|
|
return []rpc.API{
|
2015-12-15 21:26:23 -06:00
|
|
|
{
|
|
|
|
Namespace: "eth",
|
|
|
|
Version: "1.0",
|
2016-06-14 17:36:31 -05:00
|
|
|
Service: NewPublicEthereumAPI(apiBackend),
|
2015-12-15 21:26:23 -06:00
|
|
|
Public: true,
|
|
|
|
}, {
|
|
|
|
Namespace: "eth",
|
|
|
|
Version: "1.0",
|
|
|
|
Service: NewPublicBlockChainAPI(apiBackend),
|
|
|
|
Public: true,
|
|
|
|
}, {
|
|
|
|
Namespace: "eth",
|
|
|
|
Version: "1.0",
|
2017-05-25 10:08:13 -05:00
|
|
|
Service: NewPublicTransactionPoolAPI(apiBackend, nonceLock),
|
2015-12-15 21:26:23 -06:00
|
|
|
Public: true,
|
|
|
|
}, {
|
|
|
|
Namespace: "txpool",
|
|
|
|
Version: "1.0",
|
|
|
|
Service: NewPublicTxPoolAPI(apiBackend),
|
|
|
|
Public: true,
|
|
|
|
}, {
|
|
|
|
Namespace: "debug",
|
|
|
|
Version: "1.0",
|
|
|
|
Service: NewPublicDebugAPI(apiBackend),
|
|
|
|
Public: true,
|
|
|
|
}, {
|
|
|
|
Namespace: "debug",
|
|
|
|
Version: "1.0",
|
|
|
|
Service: NewPrivateDebugAPI(apiBackend),
|
|
|
|
}, {
|
|
|
|
Namespace: "eth",
|
|
|
|
Version: "1.0",
|
|
|
|
Service: NewPublicAccountAPI(apiBackend.AccountManager()),
|
|
|
|
Public: true,
|
|
|
|
}, {
|
|
|
|
Namespace: "personal",
|
|
|
|
Version: "1.0",
|
2017-05-25 10:08:13 -05:00
|
|
|
Service: NewPrivateAccountAPI(apiBackend, nonceLock),
|
2015-12-15 21:26:23 -06:00
|
|
|
Public: false,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|