mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-03-10 13:19:04 +00:00
d258e4cf2a
In this commit, the RPC API is adapted to run on top of the new Go API.
This required lots of changes to many packages, but has a few side
benefits:
- Ethereum and LightEthereum can now be used as a contract backend.
- Some duplicated code could be removed (there is added duplication in
other places though)
- It is now much easier to see which operations are unsupported with the
light client. Package les previously relied on the full node RPC API
backend, which masked several issues because the RPC API performed
direct access to the chain database.
Changes to packages in detail:
accounts/abi/bind:
- Contract call boilerplate has moved to package core.
cmd/utils:
- les now inherits the event.TypeMux from the Node instance
contracts/release:
- The ReleaseService now uses Ethereum and LightEthereum as backend.
core:
- MissingNumber is exposed so it can be used in package eth.
- GetTransaction now returns the index as an int, for convenience
reasons.
- ApplyCallMessage has been added as the new one and only
implementation of read-only contract calls.
- TxPool exposes NonceAt instead of the more general accessor for the
ManagedState.
core/types:
- Signer.SignECDSA is gone (it was basically unused).
- WithSignature doesn't return an error anymore (all implementations panic for
invalid length). I made this change to avoid code duplication in the API.
eth:
- EthApiBackend is gone. In its place, Ethereum gains many new methods
which implement a large portion of the new Go API. It does not
yet support event subscriptions and log filtering.
- Some accessors for internal objects are gone.
- ethapi.PrivateDebugAPI and ethapi.TxPoolDebugAPI are now created in
package eth for dependency reasons.
eth/downloader:
- Progress returns a pointer to simplify callers.
eth/filters:
- The Backend interface is simpler and uses the stable Go API where
possible. The new BlockReceipts method saves one DB read because
BlockReceipts also takes a block number argument.
- ChainDB is no longer passed via the Backend interface.
- EventSystem now relies on HeaderByHash for reorgs in light client mode
instead of reading from the chain database.
eth/gasprice:
- The LightPriceOracle now uses ethereum.ChainReader instead of
ethapi.Backend.
ethclient:
- TransactionByHash is adapted for the last-minute API change which
adds the isPending return value.
internal/ethapi:
- PublicTxPoolAPI is now called TxPoolDebugAPI, moved to its own file
and talks to the transaction pool instead of using the main Backend.
- The API no longer accesses the chain database directly. All access
is mediated through Backend methods.
- The backend is now split into three interfaces.
Implementing Backend is mandatory but does not require the pending
state. The other two (PendingState, TransactionInclusionBlock) are
optional and discovered at runtime.
les:
- LesApiBackend is gone, LightEthereum gets all the methods.
- Weird accessors copied from package eth are now gone as well.
light:
- TxPool.Stats now returns a queued count of zero. It implements the
ethapi.TxPool interface and can be used with TxPoolDebugAPI.
105 lines
3.6 KiB
Go
105 lines
3.6 KiB
Go
// Copyright 2016 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
|
||
|
||
import (
|
||
"fmt"
|
||
|
||
"github.com/ethereum/go-ethereum/common"
|
||
"github.com/ethereum/go-ethereum/core/types"
|
||
"github.com/ethereum/go-ethereum/rpc"
|
||
)
|
||
|
||
type TxPool interface {
|
||
Stats() (pending int, queued int)
|
||
Content() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
|
||
}
|
||
|
||
// TxPoolDebugAPI offers and API for the transaction pool. It only operates on data that
|
||
// is non confidential.
|
||
type TxPoolDebugAPI struct{ Pool TxPool }
|
||
|
||
// Content returns the transactions contained within the transaction pool.
|
||
func (s TxPoolDebugAPI) Content() map[string]map[string]map[string]*RPCTransaction {
|
||
content := map[string]map[string]map[string]*RPCTransaction{
|
||
"pending": make(map[string]map[string]*RPCTransaction),
|
||
"queued": make(map[string]map[string]*RPCTransaction),
|
||
}
|
||
pending, queue := s.Pool.Content()
|
||
|
||
// Flatten the pending transactions
|
||
for account, txs := range pending {
|
||
dump := make(map[string]*RPCTransaction)
|
||
for nonce, tx := range txs {
|
||
dump[fmt.Sprintf("%d", nonce)] = newRPCTransaction(tx)
|
||
}
|
||
content["pending"][account.Hex()] = dump
|
||
}
|
||
// Flatten the queued transactions
|
||
for account, txs := range queue {
|
||
dump := make(map[string]*RPCTransaction)
|
||
for nonce, tx := range txs {
|
||
dump[fmt.Sprintf("%d", nonce)] = newRPCTransaction(tx)
|
||
}
|
||
content["queued"][account.Hex()] = dump
|
||
}
|
||
return content
|
||
}
|
||
|
||
// Status returns the number of pending and queued transaction in the pool.
|
||
func (s TxPoolDebugAPI) Status() map[string]*rpc.HexNumber {
|
||
pending, queue := s.Pool.Stats()
|
||
return map[string]*rpc.HexNumber{
|
||
"pending": rpc.NewHexNumber(pending),
|
||
"queued": rpc.NewHexNumber(queue),
|
||
}
|
||
}
|
||
|
||
// Inspect retrieves the content of the transaction pool and flattens it into an
|
||
// easily inspectable list.
|
||
func (s TxPoolDebugAPI) Inspect() map[string]map[string]map[string]string {
|
||
content := map[string]map[string]map[string]string{
|
||
"pending": make(map[string]map[string]string),
|
||
"queued": make(map[string]map[string]string),
|
||
}
|
||
pending, queue := s.Pool.Content()
|
||
|
||
// Define a formatter to flatten a transaction into a string
|
||
var format = func(tx *types.Transaction) string {
|
||
if to := tx.To(); to != nil {
|
||
return fmt.Sprintf("%s: %v wei + %v × %v gas", tx.To().Hex(), tx.Value(), tx.Gas(), tx.GasPrice())
|
||
}
|
||
return fmt.Sprintf("contract creation: %v wei + %v × %v gas", tx.Value(), tx.Gas(), tx.GasPrice())
|
||
}
|
||
// Flatten the pending transactions
|
||
for account, txs := range pending {
|
||
dump := make(map[string]string)
|
||
for nonce, tx := range txs {
|
||
dump[fmt.Sprintf("%d", nonce)] = format(tx)
|
||
}
|
||
content["pending"][account.Hex()] = dump
|
||
}
|
||
// Flatten the queued transactions
|
||
for account, txs := range queue {
|
||
dump := make(map[string]string)
|
||
for nonce, tx := range txs {
|
||
dump[fmt.Sprintf("%d", nonce)] = format(tx)
|
||
}
|
||
content["queued"][account.Hex()] = dump
|
||
}
|
||
return content
|
||
}
|