160 lines
7.0 KiB
Go
160 lines
7.0 KiB
Go
// Copyright 2015 The go-ethereum Authors
|
|
// 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 (
|
|
"context"
|
|
"math/big"
|
|
"time"
|
|
|
|
"github.com/ethereum/go-ethereum"
|
|
"github.com/ethereum/go-ethereum/accounts"
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/consensus"
|
|
"github.com/ethereum/go-ethereum/core"
|
|
"github.com/ethereum/go-ethereum/core/bloombits"
|
|
"github.com/ethereum/go-ethereum/core/state"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/core/vm"
|
|
"github.com/ethereum/go-ethereum/ethdb"
|
|
"github.com/ethereum/go-ethereum/event"
|
|
"github.com/ethereum/go-ethereum/params"
|
|
"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 {
|
|
// General Ethereum API
|
|
SyncProgress() ethereum.SyncProgress
|
|
|
|
SuggestGasTipCap(ctx context.Context) (*big.Int, error)
|
|
FeeHistory(ctx context.Context, blockCount uint64, lastBlock rpc.BlockNumber, rewardPercentiles []float64) (*big.Int, [][]*big.Int, []*big.Int, []float64, error)
|
|
|
|
Chain() *core.BlockChain
|
|
ChainDb() ethdb.Database
|
|
AccountManager() *accounts.Manager
|
|
ExtRPCEnabled() bool
|
|
RPCGasCap() uint64 // global gas cap for eth_call over rpc: DoS protection
|
|
RPCEVMTimeout() time.Duration // global timeout for eth_call over rpc: DoS protection
|
|
RPCTxFeeCap() float64 // global tx fee cap for all transaction related APIs
|
|
UnprotectedAllowed() bool // allows only for EIP155 transactions.
|
|
|
|
// Blockchain API
|
|
SetHead(number uint64)
|
|
HeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Header, error)
|
|
HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)
|
|
HeaderByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*types.Header, error)
|
|
CurrentHeader() *types.Header
|
|
CurrentBlock() *types.Header
|
|
BlockByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Block, error)
|
|
BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)
|
|
BlockByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*types.Block, error)
|
|
StateAndHeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*state.StateDB, *types.Header, error)
|
|
StateAndHeaderByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*state.StateDB, *types.Header, error)
|
|
PendingBlockAndReceipts() (*types.Block, types.Receipts)
|
|
GetReceipts(ctx context.Context, hash common.Hash) (types.Receipts, error)
|
|
GetTd(ctx context.Context, hash common.Hash) *big.Int
|
|
GetEVM(ctx context.Context, msg *core.Message, state *state.StateDB, header *types.Header, vmConfig *vm.Config, blockCtx *vm.BlockContext) *vm.EVM
|
|
SubscribeChainEvent(ch chan<- core.ChainEvent) event.Subscription
|
|
SubscribeChainHeadEvent(ch chan<- core.ChainHeadEvent) event.Subscription
|
|
SubscribeChainSideEvent(ch chan<- core.ChainSideEvent) event.Subscription
|
|
GetBlobSidecars(ctx context.Context, hash common.Hash) (types.BlobSidecars, error)
|
|
|
|
// Transaction pool API
|
|
SendTx(ctx context.Context, signedTx *types.Transaction) error
|
|
GetTransaction(ctx context.Context, txHash common.Hash) (bool, *types.Transaction, common.Hash, uint64, uint64, error)
|
|
GetPoolTransactions() (types.Transactions, error)
|
|
GetPoolTransaction(txHash common.Hash) *types.Transaction
|
|
GetPoolNonce(ctx context.Context, addr common.Address) (uint64, error)
|
|
Stats() (pending int, queued int)
|
|
TxPoolContent() (map[common.Address][]*types.Transaction, map[common.Address][]*types.Transaction)
|
|
TxPoolContentFrom(addr common.Address) ([]*types.Transaction, []*types.Transaction)
|
|
SubscribeNewTxsEvent(chan<- core.NewTxsEvent) event.Subscription
|
|
|
|
ChainConfig() *params.ChainConfig
|
|
Engine() consensus.Engine
|
|
// CurrentValidators return the list of validator at the latest block
|
|
CurrentValidators() ([]common.Address, error)
|
|
|
|
// This is copied from filters.Backend
|
|
// eth/filters needs to be initialized from this backend type, so methods needed by
|
|
// it must also be included here.
|
|
GetBody(ctx context.Context, hash common.Hash, number rpc.BlockNumber) (*types.Body, error)
|
|
GetLogs(ctx context.Context, blockHash common.Hash, number uint64) ([][]*types.Log, error)
|
|
SubscribeRemovedLogsEvent(ch chan<- core.RemovedLogsEvent) event.Subscription
|
|
SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription
|
|
SubscribePendingLogsEvent(ch chan<- []*types.Log) event.Subscription
|
|
BloomStatus() (uint64, uint64)
|
|
ServiceFilter(ctx context.Context, session *bloombits.MatcherSession)
|
|
SubscribeFinalizedHeaderEvent(ch chan<- core.FinalizedHeaderEvent) event.Subscription
|
|
SubscribeNewVoteEvent(chan<- core.NewVoteEvent) event.Subscription
|
|
|
|
// MevRunning return true if mev is running
|
|
MevRunning() bool
|
|
// MevParams returns the static params of mev
|
|
MevParams() *types.MevParams
|
|
// StartMev starts mev
|
|
StartMev()
|
|
// StopMev stops mev
|
|
StopMev()
|
|
// AddBuilder adds a builder to the bid simulator.
|
|
AddBuilder(builder common.Address, builderUrl string) error
|
|
// RemoveBuilder removes a builder from the bid simulator.
|
|
RemoveBuilder(builder common.Address) error
|
|
// HasBuilder returns true if the builder is in the builder list.
|
|
HasBuilder(builder common.Address) bool
|
|
// SendBid receives bid from the builders.
|
|
SendBid(ctx context.Context, bid *types.BidArgs) (common.Hash, error)
|
|
// BestBidGasFee returns the gas fee of the best bid for the given parent hash.
|
|
BestBidGasFee(parentHash common.Hash) *big.Int
|
|
// MinerInTurn returns true if the validator is in turn to propose the block.
|
|
MinerInTurn() bool
|
|
}
|
|
|
|
func GetAPIs(apiBackend Backend) []rpc.API {
|
|
nonceLock := new(AddrLocker)
|
|
return []rpc.API{
|
|
{
|
|
Namespace: "eth",
|
|
Service: NewEthereumAPI(apiBackend),
|
|
}, {
|
|
Namespace: "eth",
|
|
Service: NewBlockChainAPI(apiBackend),
|
|
}, {
|
|
Namespace: "eth",
|
|
Service: NewTransactionAPI(apiBackend, nonceLock),
|
|
}, {
|
|
Namespace: "txpool",
|
|
Service: NewTxPoolAPI(apiBackend),
|
|
}, {
|
|
Namespace: "debug",
|
|
Service: NewDebugAPI(apiBackend),
|
|
}, {
|
|
Namespace: "eth",
|
|
Service: NewEthereumAccountAPI(apiBackend.AccountManager()),
|
|
}, {
|
|
Namespace: "personal",
|
|
Service: NewPersonalAccountAPI(apiBackend, nonceLock),
|
|
}, {
|
|
Namespace: "mev",
|
|
Service: NewMevAPI(apiBackend),
|
|
},
|
|
}
|
|
}
|