54253aae4c
* internal/ethapi: return empty arrays instead of null * internal/ethapi: minor comments to avoid future regressions
1460 lines
51 KiB
Go
1460 lines
51 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
|
||
|
||
import (
|
||
"bytes"
|
||
"context"
|
||
"encoding/hex"
|
||
"errors"
|
||
"fmt"
|
||
"math/big"
|
||
"strings"
|
||
"time"
|
||
|
||
"github.com/ethereum/go-ethereum/accounts"
|
||
"github.com/ethereum/go-ethereum/accounts/keystore"
|
||
"github.com/ethereum/go-ethereum/common"
|
||
"github.com/ethereum/go-ethereum/common/hexutil"
|
||
"github.com/ethereum/go-ethereum/common/math"
|
||
"github.com/ethereum/go-ethereum/consensus/ethash"
|
||
"github.com/ethereum/go-ethereum/core"
|
||
"github.com/ethereum/go-ethereum/core/types"
|
||
"github.com/ethereum/go-ethereum/core/vm"
|
||
"github.com/ethereum/go-ethereum/crypto"
|
||
"github.com/ethereum/go-ethereum/ethdb"
|
||
"github.com/ethereum/go-ethereum/log"
|
||
"github.com/ethereum/go-ethereum/p2p"
|
||
"github.com/ethereum/go-ethereum/params"
|
||
"github.com/ethereum/go-ethereum/rlp"
|
||
"github.com/ethereum/go-ethereum/rpc"
|
||
"github.com/syndtr/goleveldb/leveldb"
|
||
"github.com/syndtr/goleveldb/leveldb/util"
|
||
)
|
||
|
||
const (
|
||
defaultGas = 90000
|
||
defaultGasPrice = 50 * params.Shannon
|
||
emptyHex = "0x"
|
||
)
|
||
|
||
// PublicEthereumAPI provides an API to access Ethereum related information.
|
||
// It offers only methods that operate on public data that is freely available to anyone.
|
||
type PublicEthereumAPI struct {
|
||
b Backend
|
||
}
|
||
|
||
// NewPublicEthereumAPI creates a new Etheruem protocol API.
|
||
func NewPublicEthereumAPI(b Backend) *PublicEthereumAPI {
|
||
return &PublicEthereumAPI{b}
|
||
}
|
||
|
||
// GasPrice returns a suggestion for a gas price.
|
||
func (s *PublicEthereumAPI) GasPrice(ctx context.Context) (*big.Int, error) {
|
||
return s.b.SuggestPrice(ctx)
|
||
}
|
||
|
||
// ProtocolVersion returns the current Ethereum protocol version this node supports
|
||
func (s *PublicEthereumAPI) ProtocolVersion() hexutil.Uint {
|
||
return hexutil.Uint(s.b.ProtocolVersion())
|
||
}
|
||
|
||
// Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not
|
||
// yet received the latest block headers from its pears. In case it is synchronizing:
|
||
// - startingBlock: block number this node started to synchronise from
|
||
// - currentBlock: block number this node is currently importing
|
||
// - highestBlock: block number of the highest block header this node has received from peers
|
||
// - pulledStates: number of state entries processed until now
|
||
// - knownStates: number of known state entries that still need to be pulled
|
||
func (s *PublicEthereumAPI) Syncing() (interface{}, error) {
|
||
progress := s.b.Downloader().Progress()
|
||
|
||
// Return not syncing if the synchronisation already completed
|
||
if progress.CurrentBlock >= progress.HighestBlock {
|
||
return false, nil
|
||
}
|
||
// Otherwise gather the block sync stats
|
||
return map[string]interface{}{
|
||
"startingBlock": hexutil.Uint64(progress.StartingBlock),
|
||
"currentBlock": hexutil.Uint64(progress.CurrentBlock),
|
||
"highestBlock": hexutil.Uint64(progress.HighestBlock),
|
||
"pulledStates": hexutil.Uint64(progress.PulledStates),
|
||
"knownStates": hexutil.Uint64(progress.KnownStates),
|
||
}, nil
|
||
}
|
||
|
||
// PublicTxPoolAPI offers and API for the transaction pool. It only operates on data that is non confidential.
|
||
type PublicTxPoolAPI struct {
|
||
b Backend
|
||
}
|
||
|
||
// NewPublicTxPoolAPI creates a new tx pool service that gives information about the transaction pool.
|
||
func NewPublicTxPoolAPI(b Backend) *PublicTxPoolAPI {
|
||
return &PublicTxPoolAPI{b}
|
||
}
|
||
|
||
// Content returns the transactions contained within the transaction pool.
|
||
func (s *PublicTxPoolAPI) 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.b.TxPoolContent()
|
||
|
||
// Flatten the pending transactions
|
||
for account, txs := range pending {
|
||
dump := make(map[string]*RPCTransaction)
|
||
for nonce, tx := range txs {
|
||
dump[fmt.Sprintf("%d", nonce)] = newRPCPendingTransaction(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)] = newRPCPendingTransaction(tx)
|
||
}
|
||
content["queued"][account.Hex()] = dump
|
||
}
|
||
return content
|
||
}
|
||
|
||
// Status returns the number of pending and queued transaction in the pool.
|
||
func (s *PublicTxPoolAPI) Status() map[string]hexutil.Uint {
|
||
pending, queue := s.b.Stats()
|
||
return map[string]hexutil.Uint{
|
||
"pending": hexutil.Uint(pending),
|
||
"queued": hexutil.Uint(queue),
|
||
}
|
||
}
|
||
|
||
// Inspect retrieves the content of the transaction pool and flattens it into an
|
||
// easily inspectable list.
|
||
func (s *PublicTxPoolAPI) 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.b.TxPoolContent()
|
||
|
||
// 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
|
||
}
|
||
|
||
// PublicAccountAPI provides an API to access accounts managed by this node.
|
||
// It offers only methods that can retrieve accounts.
|
||
type PublicAccountAPI struct {
|
||
am *accounts.Manager
|
||
}
|
||
|
||
// NewPublicAccountAPI creates a new PublicAccountAPI.
|
||
func NewPublicAccountAPI(am *accounts.Manager) *PublicAccountAPI {
|
||
return &PublicAccountAPI{am: am}
|
||
}
|
||
|
||
// Accounts returns the collection of accounts this node manages
|
||
func (s *PublicAccountAPI) Accounts() []common.Address {
|
||
addresses := make([]common.Address, 0) // return [] instead of nil if empty
|
||
for _, wallet := range s.am.Wallets() {
|
||
for _, account := range wallet.Accounts() {
|
||
addresses = append(addresses, account.Address)
|
||
}
|
||
}
|
||
return addresses
|
||
}
|
||
|
||
// PrivateAccountAPI provides an API to access accounts managed by this node.
|
||
// It offers methods to create, (un)lock en list accounts. Some methods accept
|
||
// passwords and are therefore considered private by default.
|
||
type PrivateAccountAPI struct {
|
||
am *accounts.Manager
|
||
b Backend
|
||
}
|
||
|
||
// NewPrivateAccountAPI create a new PrivateAccountAPI.
|
||
func NewPrivateAccountAPI(b Backend) *PrivateAccountAPI {
|
||
return &PrivateAccountAPI{
|
||
am: b.AccountManager(),
|
||
b: b,
|
||
}
|
||
}
|
||
|
||
// ListAccounts will return a list of addresses for accounts this node manages.
|
||
func (s *PrivateAccountAPI) ListAccounts() []common.Address {
|
||
addresses := make([]common.Address, 0) // return [] instead of nil if empty
|
||
for _, wallet := range s.am.Wallets() {
|
||
for _, account := range wallet.Accounts() {
|
||
addresses = append(addresses, account.Address)
|
||
}
|
||
}
|
||
return addresses
|
||
}
|
||
|
||
// rawWallet is a JSON representation of an accounts.Wallet interface, with its
|
||
// data contents extracted into plain fields.
|
||
type rawWallet struct {
|
||
URL string `json:"url"`
|
||
Status string `json:"status"`
|
||
Accounts []accounts.Account `json:"accounts"`
|
||
}
|
||
|
||
// ListWallets will return a list of wallets this node manages.
|
||
func (s *PrivateAccountAPI) ListWallets() []rawWallet {
|
||
wallets := make([]rawWallet, 0) // return [] instead of nil if empty
|
||
for _, wallet := range s.am.Wallets() {
|
||
wallets = append(wallets, rawWallet{
|
||
URL: wallet.URL().String(),
|
||
Status: wallet.Status(),
|
||
Accounts: wallet.Accounts(),
|
||
})
|
||
}
|
||
return wallets
|
||
}
|
||
|
||
// DeriveAccount requests a HD wallet to derive a new account, optionally pinning
|
||
// it for later reuse.
|
||
func (s *PrivateAccountAPI) DeriveAccount(url string, path string, pin *bool) (accounts.Account, error) {
|
||
wallet, err := s.am.Wallet(url)
|
||
if err != nil {
|
||
return accounts.Account{}, err
|
||
}
|
||
derivPath, err := accounts.ParseDerivationPath(path)
|
||
if err != nil {
|
||
return accounts.Account{}, err
|
||
}
|
||
if pin == nil {
|
||
pin = new(bool)
|
||
}
|
||
return wallet.Derive(derivPath, *pin)
|
||
}
|
||
|
||
// NewAccount will create a new account and returns the address for the new account.
|
||
func (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) {
|
||
acc, err := fetchKeystore(s.am).NewAccount(password)
|
||
if err == nil {
|
||
return acc.Address, nil
|
||
}
|
||
return common.Address{}, err
|
||
}
|
||
|
||
// fetchKeystore retrives the encrypted keystore from the account manager.
|
||
func fetchKeystore(am *accounts.Manager) *keystore.KeyStore {
|
||
return am.Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
|
||
}
|
||
|
||
// ImportRawKey stores the given hex encoded ECDSA key into the key directory,
|
||
// encrypting it with the passphrase.
|
||
func (s *PrivateAccountAPI) ImportRawKey(privkey string, password string) (common.Address, error) {
|
||
hexkey, err := hex.DecodeString(privkey)
|
||
if err != nil {
|
||
return common.Address{}, err
|
||
}
|
||
|
||
acc, err := fetchKeystore(s.am).ImportECDSA(crypto.ToECDSA(hexkey), password)
|
||
return acc.Address, err
|
||
}
|
||
|
||
// UnlockAccount will unlock the account associated with the given address with
|
||
// the given password for duration seconds. If duration is nil it will use a
|
||
// default of 300 seconds. It returns an indication if the account was unlocked.
|
||
func (s *PrivateAccountAPI) UnlockAccount(addr common.Address, password string, duration *uint64) (bool, error) {
|
||
const max = uint64(time.Duration(math.MaxInt64) / time.Second)
|
||
var d time.Duration
|
||
if duration == nil {
|
||
d = 300 * time.Second
|
||
} else if *duration > max {
|
||
return false, errors.New("unlock duration too large")
|
||
} else {
|
||
d = time.Duration(*duration) * time.Second
|
||
}
|
||
err := fetchKeystore(s.am).TimedUnlock(accounts.Account{Address: addr}, password, d)
|
||
return err == nil, err
|
||
}
|
||
|
||
// LockAccount will lock the account associated with the given address when it's unlocked.
|
||
func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool {
|
||
return fetchKeystore(s.am).Lock(addr) == nil
|
||
}
|
||
|
||
// SendTransaction will create a transaction from the given arguments and
|
||
// tries to sign it with the key associated with args.To. If the given passwd isn't
|
||
// able to decrypt the key it fails.
|
||
func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
|
||
// Set some sanity defaults and terminate on failure
|
||
if err := args.setDefaults(ctx, s.b); err != nil {
|
||
return common.Hash{}, err
|
||
}
|
||
// Look up the wallet containing the requested signer
|
||
account := accounts.Account{Address: args.From}
|
||
|
||
wallet, err := s.am.Find(account)
|
||
if err != nil {
|
||
return common.Hash{}, err
|
||
}
|
||
// Assemble the transaction and sign with the wallet
|
||
tx := args.toTransaction()
|
||
|
||
var chainID *big.Int
|
||
if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
|
||
chainID = config.ChainId
|
||
}
|
||
signed, err := wallet.SignTxWithPassphrase(account, passwd, tx, chainID)
|
||
if err != nil {
|
||
return common.Hash{}, err
|
||
}
|
||
return submitTransaction(ctx, s.b, signed)
|
||
}
|
||
|
||
// signHash is a helper function that calculates a hash for the given message that can be
|
||
// safely used to calculate a signature from.
|
||
//
|
||
// The hash is calulcated as
|
||
// keccak256("\x19Ethereum Signed Message:\n"${message length}${message}).
|
||
//
|
||
// This gives context to the signed message and prevents signing of transactions.
|
||
func signHash(data []byte) []byte {
|
||
msg := fmt.Sprintf("\x19Ethereum Signed Message:\n%d%s", len(data), data)
|
||
return crypto.Keccak256([]byte(msg))
|
||
}
|
||
|
||
// Sign calculates an Ethereum ECDSA signature for:
|
||
// keccack256("\x19Ethereum Signed Message:\n" + len(message) + message))
|
||
//
|
||
// Note, the produced signature conforms to the secp256k1 curve R, S and V values,
|
||
// where the V value will be 27 or 28 for legacy reasons.
|
||
//
|
||
// The key used to calculate the signature is decrypted with the given password.
|
||
//
|
||
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign
|
||
func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {
|
||
// Look up the wallet containing the requested signer
|
||
account := accounts.Account{Address: addr}
|
||
|
||
wallet, err := s.b.AccountManager().Find(account)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
// Assemble sign the data with the wallet
|
||
signature, err := wallet.SignHashWithPassphrase(account, passwd, signHash(data))
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
|
||
return signature, nil
|
||
}
|
||
|
||
// EcRecover returns the address for the account that was used to create the signature.
|
||
// Note, this function is compatible with eth_sign and personal_sign. As such it recovers
|
||
// the address of:
|
||
// hash = keccak256("\x19Ethereum Signed Message:\n"${message length}${message})
|
||
// addr = ecrecover(hash, signature)
|
||
//
|
||
// Note, the signature must conform to the secp256k1 curve R, S and V values, where
|
||
// the V value must be be 27 or 28 for legacy reasons.
|
||
//
|
||
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover
|
||
func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {
|
||
if len(sig) != 65 {
|
||
return common.Address{}, fmt.Errorf("signature must be 65 bytes long")
|
||
}
|
||
if sig[64] != 27 && sig[64] != 28 {
|
||
return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)")
|
||
}
|
||
sig[64] -= 27 // Transform yellow paper V from 27/28 to 0/1
|
||
|
||
rpk, err := crypto.Ecrecover(signHash(data), sig)
|
||
if err != nil {
|
||
return common.Address{}, err
|
||
}
|
||
pubKey := crypto.ToECDSAPub(rpk)
|
||
recoveredAddr := crypto.PubkeyToAddress(*pubKey)
|
||
return recoveredAddr, nil
|
||
}
|
||
|
||
// SignAndSendTransaction was renamed to SendTransaction. This method is deprecated
|
||
// and will be removed in the future. It primary goal is to give clients time to update.
|
||
func (s *PrivateAccountAPI) SignAndSendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
|
||
return s.SendTransaction(ctx, args, passwd)
|
||
}
|
||
|
||
// PublicBlockChainAPI provides an API to access the Ethereum blockchain.
|
||
// It offers only methods that operate on public data that is freely available to anyone.
|
||
type PublicBlockChainAPI struct {
|
||
b Backend
|
||
}
|
||
|
||
// NewPublicBlockChainAPI creates a new Etheruem blockchain API.
|
||
func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI {
|
||
return &PublicBlockChainAPI{b}
|
||
}
|
||
|
||
// BlockNumber returns the block number of the chain head.
|
||
func (s *PublicBlockChainAPI) BlockNumber() *big.Int {
|
||
header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available
|
||
return header.Number
|
||
}
|
||
|
||
// GetBalance returns the amount of wei for the given address in the state of the
|
||
// given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta
|
||
// block numbers are also allowed.
|
||
func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*big.Int, error) {
|
||
state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
|
||
if state == nil || err != nil {
|
||
return nil, err
|
||
}
|
||
|
||
return state.GetBalance(ctx, address)
|
||
}
|
||
|
||
// GetBlockByNumber returns the requested block. When blockNr is -1 the chain head is returned. When fullTx is true all
|
||
// transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
|
||
func (s *PublicBlockChainAPI) GetBlockByNumber(ctx context.Context, blockNr rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) {
|
||
block, err := s.b.BlockByNumber(ctx, blockNr)
|
||
if block != nil {
|
||
response, err := s.rpcOutputBlock(block, true, fullTx)
|
||
if err == nil && blockNr == rpc.PendingBlockNumber {
|
||
// Pending blocks need to nil out a few fields
|
||
for _, field := range []string{"hash", "nonce", "miner"} {
|
||
response[field] = nil
|
||
}
|
||
}
|
||
return response, err
|
||
}
|
||
return nil, err
|
||
}
|
||
|
||
// GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full
|
||
// detail, otherwise only the transaction hash is returned.
|
||
func (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, blockHash common.Hash, fullTx bool) (map[string]interface{}, error) {
|
||
block, err := s.b.GetBlock(ctx, blockHash)
|
||
if block != nil {
|
||
return s.rpcOutputBlock(block, true, fullTx)
|
||
}
|
||
return nil, err
|
||
}
|
||
|
||
// GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true
|
||
// all transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
|
||
func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {
|
||
block, err := s.b.BlockByNumber(ctx, blockNr)
|
||
if block != nil {
|
||
uncles := block.Uncles()
|
||
if index >= hexutil.Uint(len(uncles)) {
|
||
log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index)
|
||
return nil, nil
|
||
}
|
||
block = types.NewBlockWithHeader(uncles[index])
|
||
return s.rpcOutputBlock(block, false, false)
|
||
}
|
||
return nil, err
|
||
}
|
||
|
||
// GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true
|
||
// all transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
|
||
func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {
|
||
block, err := s.b.GetBlock(ctx, blockHash)
|
||
if block != nil {
|
||
uncles := block.Uncles()
|
||
if index >= hexutil.Uint(len(uncles)) {
|
||
log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index)
|
||
return nil, nil
|
||
}
|
||
block = types.NewBlockWithHeader(uncles[index])
|
||
return s.rpcOutputBlock(block, false, false)
|
||
}
|
||
return nil, err
|
||
}
|
||
|
||
// GetUncleCountByBlockNumber returns number of uncles in the block for the given block number
|
||
func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
|
||
if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
|
||
n := hexutil.Uint(len(block.Uncles()))
|
||
return &n
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// GetUncleCountByBlockHash returns number of uncles in the block for the given block hash
|
||
func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
|
||
if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
|
||
n := hexutil.Uint(len(block.Uncles()))
|
||
return &n
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// GetCode returns the code stored at the given address in the state for the given block number.
|
||
func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (string, error) {
|
||
state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
|
||
if state == nil || err != nil {
|
||
return "", err
|
||
}
|
||
res, err := state.GetCode(ctx, address)
|
||
if len(res) == 0 || err != nil { // backwards compatibility
|
||
return "0x", err
|
||
}
|
||
return common.ToHex(res), nil
|
||
}
|
||
|
||
// GetStorageAt returns the storage from the state at the given address, key and
|
||
// block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block
|
||
// numbers are also allowed.
|
||
func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNr rpc.BlockNumber) (string, error) {
|
||
state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
|
||
if state == nil || err != nil {
|
||
return "0x", err
|
||
}
|
||
res, err := state.GetState(ctx, address, common.HexToHash(key))
|
||
if err != nil {
|
||
return "0x", err
|
||
}
|
||
return res.Hex(), nil
|
||
}
|
||
|
||
// callmsg is the message type used for call transitions.
|
||
type callmsg struct {
|
||
addr common.Address
|
||
to *common.Address
|
||
gas, gasPrice *big.Int
|
||
value *big.Int
|
||
data []byte
|
||
}
|
||
|
||
// accessor boilerplate to implement core.Message
|
||
func (m callmsg) From() (common.Address, error) { return m.addr, nil }
|
||
func (m callmsg) FromFrontier() (common.Address, error) { return m.addr, nil }
|
||
func (m callmsg) Nonce() uint64 { return 0 }
|
||
func (m callmsg) CheckNonce() bool { return false }
|
||
func (m callmsg) To() *common.Address { return m.to }
|
||
func (m callmsg) GasPrice() *big.Int { return m.gasPrice }
|
||
func (m callmsg) Gas() *big.Int { return m.gas }
|
||
func (m callmsg) Value() *big.Int { return m.value }
|
||
func (m callmsg) Data() []byte { return m.data }
|
||
|
||
// CallArgs represents the arguments for a call.
|
||
type CallArgs struct {
|
||
From common.Address `json:"from"`
|
||
To *common.Address `json:"to"`
|
||
Gas hexutil.Big `json:"gas"`
|
||
GasPrice hexutil.Big `json:"gasPrice"`
|
||
Value hexutil.Big `json:"value"`
|
||
Data hexutil.Bytes `json:"data"`
|
||
}
|
||
|
||
func (s *PublicBlockChainAPI) doCall(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber, vmCfg vm.Config) ([]byte, *big.Int, error) {
|
||
defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now())
|
||
|
||
state, header, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
|
||
if state == nil || err != nil {
|
||
return nil, common.Big0, err
|
||
}
|
||
// Set sender address or use a default if none specified
|
||
addr := args.From
|
||
if addr == (common.Address{}) {
|
||
if wallets := s.b.AccountManager().Wallets(); len(wallets) > 0 {
|
||
if accounts := wallets[0].Accounts(); len(accounts) > 0 {
|
||
addr = accounts[0].Address
|
||
}
|
||
}
|
||
}
|
||
// Set default gas & gas price if none were set
|
||
gas, gasPrice := args.Gas.ToInt(), args.GasPrice.ToInt()
|
||
if gas.Sign() == 0 {
|
||
gas = big.NewInt(50000000)
|
||
}
|
||
if gasPrice.Sign() == 0 {
|
||
gasPrice = new(big.Int).SetUint64(defaultGasPrice)
|
||
}
|
||
|
||
// Create new call message
|
||
msg := types.NewMessage(addr, args.To, 0, args.Value.ToInt(), gas, gasPrice, args.Data, false)
|
||
|
||
// Setup context so it may be cancelled the call has completed
|
||
// or, in case of unmetered gas, setup a context with a timeout.
|
||
var cancel context.CancelFunc
|
||
if vmCfg.DisableGasMetering {
|
||
ctx, cancel = context.WithTimeout(ctx, time.Second*5)
|
||
} else {
|
||
ctx, cancel = context.WithCancel(ctx)
|
||
}
|
||
// Make sure the context is cancelled when the call has completed
|
||
// this makes sure resources are cleaned up.
|
||
defer func() { cancel() }()
|
||
|
||
// Get a new instance of the EVM.
|
||
evm, vmError, err := s.b.GetEVM(ctx, msg, state, header, vmCfg)
|
||
if err != nil {
|
||
return nil, common.Big0, err
|
||
}
|
||
// Wait for the context to be done and cancel the evm. Even if the
|
||
// EVM has finished, cancelling may be done (repeatedly)
|
||
go func() {
|
||
select {
|
||
case <-ctx.Done():
|
||
evm.Cancel()
|
||
}
|
||
}()
|
||
|
||
// Setup the gas pool (also for unmetered requests)
|
||
// and apply the message.
|
||
gp := new(core.GasPool).AddGas(math.MaxBig256)
|
||
res, gas, err := core.ApplyMessage(evm, msg, gp)
|
||
if err := vmError(); err != nil {
|
||
return nil, common.Big0, err
|
||
}
|
||
return res, gas, err
|
||
}
|
||
|
||
// Call executes the given transaction on the state for the given block number.
|
||
// It doesn't make and changes in the state/blockchain and is useful to execute and retrieve values.
|
||
func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
|
||
result, _, err := s.doCall(ctx, args, blockNr, vm.Config{DisableGasMetering: true})
|
||
return (hexutil.Bytes)(result), err
|
||
}
|
||
|
||
// EstimateGas returns an estimate of the amount of gas needed to execute the given transaction.
|
||
func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (*hexutil.Big, error) {
|
||
// Binary search the gas requirement, as it may be higher than the amount used
|
||
var lo, hi uint64
|
||
if (*big.Int)(&args.Gas).Sign() != 0 {
|
||
hi = (*big.Int)(&args.Gas).Uint64()
|
||
} else {
|
||
// Retrieve the current pending block to act as the gas ceiling
|
||
block, err := s.b.BlockByNumber(ctx, rpc.PendingBlockNumber)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
hi = block.GasLimit().Uint64()
|
||
}
|
||
for lo+1 < hi {
|
||
// Take a guess at the gas, and check transaction validity
|
||
mid := (hi + lo) / 2
|
||
(*big.Int)(&args.Gas).SetUint64(mid)
|
||
|
||
_, gas, err := s.doCall(ctx, args, rpc.PendingBlockNumber, vm.Config{})
|
||
|
||
// If the transaction became invalid or used all the gas (failed), raise the gas limit
|
||
if err != nil || gas.Cmp((*big.Int)(&args.Gas)) == 0 {
|
||
lo = mid
|
||
continue
|
||
}
|
||
// Otherwise assume the transaction succeeded, lower the gas limit
|
||
hi = mid
|
||
}
|
||
return (*hexutil.Big)(new(big.Int).SetUint64(hi)), nil
|
||
}
|
||
|
||
// ExecutionResult groups all structured logs emitted by the EVM
|
||
// while replaying a transaction in debug mode as well as the amount of
|
||
// gas used and the return value
|
||
type ExecutionResult struct {
|
||
Gas *big.Int `json:"gas"`
|
||
ReturnValue string `json:"returnValue"`
|
||
StructLogs []StructLogRes `json:"structLogs"`
|
||
}
|
||
|
||
// StructLogRes stores a structured log emitted by the EVM while replaying a
|
||
// transaction in debug mode
|
||
type StructLogRes struct {
|
||
Pc uint64 `json:"pc"`
|
||
Op string `json:"op"`
|
||
Gas uint64 `json:"gas"`
|
||
GasCost uint64 `json:"gasCost"`
|
||
Depth int `json:"depth"`
|
||
Error error `json:"error"`
|
||
Stack []string `json:"stack"`
|
||
Memory []string `json:"memory"`
|
||
Storage map[string]string `json:"storage"`
|
||
}
|
||
|
||
// formatLogs formats EVM returned structured logs for json output
|
||
func FormatLogs(structLogs []vm.StructLog) []StructLogRes {
|
||
formattedStructLogs := make([]StructLogRes, len(structLogs))
|
||
for index, trace := range structLogs {
|
||
formattedStructLogs[index] = StructLogRes{
|
||
Pc: trace.Pc,
|
||
Op: trace.Op.String(),
|
||
Gas: trace.Gas,
|
||
GasCost: trace.GasCost,
|
||
Depth: trace.Depth,
|
||
Error: trace.Err,
|
||
Stack: make([]string, len(trace.Stack)),
|
||
Storage: make(map[string]string),
|
||
}
|
||
|
||
for i, stackValue := range trace.Stack {
|
||
formattedStructLogs[index].Stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32))
|
||
}
|
||
|
||
for i := 0; i+32 <= len(trace.Memory); i += 32 {
|
||
formattedStructLogs[index].Memory = append(formattedStructLogs[index].Memory, fmt.Sprintf("%x", trace.Memory[i:i+32]))
|
||
}
|
||
|
||
for i, storageValue := range trace.Storage {
|
||
formattedStructLogs[index].Storage[fmt.Sprintf("%x", i)] = fmt.Sprintf("%x", storageValue)
|
||
}
|
||
}
|
||
return formattedStructLogs
|
||
}
|
||
|
||
// rpcOutputBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are
|
||
// returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain
|
||
// transaction hashes.
|
||
func (s *PublicBlockChainAPI) rpcOutputBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
|
||
head := b.Header() // copies the header once
|
||
fields := map[string]interface{}{
|
||
"number": (*hexutil.Big)(head.Number),
|
||
"hash": b.Hash(),
|
||
"parentHash": head.ParentHash,
|
||
"nonce": head.Nonce,
|
||
"mixHash": head.MixDigest,
|
||
"sha3Uncles": head.UncleHash,
|
||
"logsBloom": head.Bloom,
|
||
"stateRoot": head.Root,
|
||
"miner": head.Coinbase,
|
||
"difficulty": (*hexutil.Big)(head.Difficulty),
|
||
"totalDifficulty": (*hexutil.Big)(s.b.GetTd(b.Hash())),
|
||
"extraData": hexutil.Bytes(head.Extra),
|
||
"size": hexutil.Uint64(uint64(b.Size().Int64())),
|
||
"gasLimit": (*hexutil.Big)(head.GasLimit),
|
||
"gasUsed": (*hexutil.Big)(head.GasUsed),
|
||
"timestamp": (*hexutil.Big)(head.Time),
|
||
"transactionsRoot": head.TxHash,
|
||
"receiptsRoot": head.ReceiptHash,
|
||
}
|
||
|
||
if inclTx {
|
||
formatTx := func(tx *types.Transaction) (interface{}, error) {
|
||
return tx.Hash(), nil
|
||
}
|
||
|
||
if fullTx {
|
||
formatTx = func(tx *types.Transaction) (interface{}, error) {
|
||
return newRPCTransaction(b, tx.Hash())
|
||
}
|
||
}
|
||
|
||
txs := b.Transactions()
|
||
transactions := make([]interface{}, len(txs))
|
||
var err error
|
||
for i, tx := range b.Transactions() {
|
||
if transactions[i], err = formatTx(tx); err != nil {
|
||
return nil, err
|
||
}
|
||
}
|
||
fields["transactions"] = transactions
|
||
}
|
||
|
||
uncles := b.Uncles()
|
||
uncleHashes := make([]common.Hash, len(uncles))
|
||
for i, uncle := range uncles {
|
||
uncleHashes[i] = uncle.Hash()
|
||
}
|
||
fields["uncles"] = uncleHashes
|
||
|
||
return fields, nil
|
||
}
|
||
|
||
// RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction
|
||
type RPCTransaction struct {
|
||
BlockHash common.Hash `json:"blockHash"`
|
||
BlockNumber *hexutil.Big `json:"blockNumber"`
|
||
From common.Address `json:"from"`
|
||
Gas *hexutil.Big `json:"gas"`
|
||
GasPrice *hexutil.Big `json:"gasPrice"`
|
||
Hash common.Hash `json:"hash"`
|
||
Input hexutil.Bytes `json:"input"`
|
||
Nonce hexutil.Uint64 `json:"nonce"`
|
||
To *common.Address `json:"to"`
|
||
TransactionIndex hexutil.Uint `json:"transactionIndex"`
|
||
Value *hexutil.Big `json:"value"`
|
||
V *hexutil.Big `json:"v"`
|
||
R *hexutil.Big `json:"r"`
|
||
S *hexutil.Big `json:"s"`
|
||
}
|
||
|
||
// newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation
|
||
func newRPCPendingTransaction(tx *types.Transaction) *RPCTransaction {
|
||
var signer types.Signer = types.FrontierSigner{}
|
||
if tx.Protected() {
|
||
signer = types.NewEIP155Signer(tx.ChainId())
|
||
}
|
||
from, _ := types.Sender(signer, tx)
|
||
v, r, s := tx.RawSignatureValues()
|
||
return &RPCTransaction{
|
||
From: from,
|
||
Gas: (*hexutil.Big)(tx.Gas()),
|
||
GasPrice: (*hexutil.Big)(tx.GasPrice()),
|
||
Hash: tx.Hash(),
|
||
Input: hexutil.Bytes(tx.Data()),
|
||
Nonce: hexutil.Uint64(tx.Nonce()),
|
||
To: tx.To(),
|
||
Value: (*hexutil.Big)(tx.Value()),
|
||
V: (*hexutil.Big)(v),
|
||
R: (*hexutil.Big)(r),
|
||
S: (*hexutil.Big)(s),
|
||
}
|
||
}
|
||
|
||
// newRPCTransaction returns a transaction that will serialize to the RPC representation.
|
||
func newRPCTransactionFromBlockIndex(b *types.Block, txIndex uint) (*RPCTransaction, error) {
|
||
if txIndex < uint(len(b.Transactions())) {
|
||
tx := b.Transactions()[txIndex]
|
||
var signer types.Signer = types.FrontierSigner{}
|
||
if tx.Protected() {
|
||
signer = types.NewEIP155Signer(tx.ChainId())
|
||
}
|
||
from, _ := types.Sender(signer, tx)
|
||
v, r, s := tx.RawSignatureValues()
|
||
return &RPCTransaction{
|
||
BlockHash: b.Hash(),
|
||
BlockNumber: (*hexutil.Big)(b.Number()),
|
||
From: from,
|
||
Gas: (*hexutil.Big)(tx.Gas()),
|
||
GasPrice: (*hexutil.Big)(tx.GasPrice()),
|
||
Hash: tx.Hash(),
|
||
Input: hexutil.Bytes(tx.Data()),
|
||
Nonce: hexutil.Uint64(tx.Nonce()),
|
||
To: tx.To(),
|
||
TransactionIndex: hexutil.Uint(txIndex),
|
||
Value: (*hexutil.Big)(tx.Value()),
|
||
V: (*hexutil.Big)(v),
|
||
R: (*hexutil.Big)(r),
|
||
S: (*hexutil.Big)(s),
|
||
}, nil
|
||
}
|
||
|
||
return nil, nil
|
||
}
|
||
|
||
// newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index.
|
||
func newRPCRawTransactionFromBlockIndex(b *types.Block, txIndex uint) (hexutil.Bytes, error) {
|
||
if txIndex < uint(len(b.Transactions())) {
|
||
tx := b.Transactions()[txIndex]
|
||
return rlp.EncodeToBytes(tx)
|
||
}
|
||
|
||
return nil, nil
|
||
}
|
||
|
||
// newRPCTransaction returns a transaction that will serialize to the RPC representation.
|
||
func newRPCTransaction(b *types.Block, txHash common.Hash) (*RPCTransaction, error) {
|
||
for idx, tx := range b.Transactions() {
|
||
if tx.Hash() == txHash {
|
||
return newRPCTransactionFromBlockIndex(b, uint(idx))
|
||
}
|
||
}
|
||
|
||
return nil, nil
|
||
}
|
||
|
||
// PublicTransactionPoolAPI exposes methods for the RPC interface
|
||
type PublicTransactionPoolAPI struct {
|
||
b Backend
|
||
}
|
||
|
||
// NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
|
||
func NewPublicTransactionPoolAPI(b Backend) *PublicTransactionPoolAPI {
|
||
return &PublicTransactionPoolAPI{b}
|
||
}
|
||
|
||
func getTransaction(chainDb ethdb.Database, b Backend, txHash common.Hash) (*types.Transaction, bool, error) {
|
||
txData, err := chainDb.Get(txHash.Bytes())
|
||
isPending := false
|
||
tx := new(types.Transaction)
|
||
|
||
if err == nil && len(txData) > 0 {
|
||
if err := rlp.DecodeBytes(txData, tx); err != nil {
|
||
return nil, isPending, err
|
||
}
|
||
} else {
|
||
// pending transaction?
|
||
tx = b.GetPoolTransaction(txHash)
|
||
isPending = true
|
||
}
|
||
|
||
return tx, isPending, nil
|
||
}
|
||
|
||
// GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
|
||
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
|
||
if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
|
||
n := hexutil.Uint(len(block.Transactions()))
|
||
return &n
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
|
||
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
|
||
if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
|
||
n := hexutil.Uint(len(block.Transactions()))
|
||
return &n
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
|
||
func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (*RPCTransaction, error) {
|
||
if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
|
||
return newRPCTransactionFromBlockIndex(block, uint(index))
|
||
}
|
||
return nil, nil
|
||
}
|
||
|
||
// GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
|
||
func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (*RPCTransaction, error) {
|
||
if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
|
||
return newRPCTransactionFromBlockIndex(block, uint(index))
|
||
}
|
||
return nil, nil
|
||
}
|
||
|
||
// GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
|
||
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (hexutil.Bytes, error) {
|
||
if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
|
||
return newRPCRawTransactionFromBlockIndex(block, uint(index))
|
||
}
|
||
return nil, nil
|
||
}
|
||
|
||
// GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
|
||
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (hexutil.Bytes, error) {
|
||
if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
|
||
return newRPCRawTransactionFromBlockIndex(block, uint(index))
|
||
}
|
||
return nil, nil
|
||
}
|
||
|
||
// GetTransactionCount returns the number of transactions the given address has sent for the given block number
|
||
func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) {
|
||
state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
|
||
if state == nil || err != nil {
|
||
return nil, err
|
||
}
|
||
nonce, err := state.GetNonce(ctx, address)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
return (*hexutil.Uint64)(&nonce), nil
|
||
}
|
||
|
||
// getTransactionBlockData fetches the meta data for the given transaction from the chain database. This is useful to
|
||
// retrieve block information for a hash. It returns the block hash, block index and transaction index.
|
||
func getTransactionBlockData(chainDb ethdb.Database, txHash common.Hash) (common.Hash, uint64, uint64, error) {
|
||
var txBlock struct {
|
||
BlockHash common.Hash
|
||
BlockIndex uint64
|
||
Index uint64
|
||
}
|
||
|
||
blockData, err := chainDb.Get(append(txHash.Bytes(), 0x0001))
|
||
if err != nil {
|
||
return common.Hash{}, uint64(0), uint64(0), err
|
||
}
|
||
|
||
reader := bytes.NewReader(blockData)
|
||
if err = rlp.Decode(reader, &txBlock); err != nil {
|
||
return common.Hash{}, uint64(0), uint64(0), err
|
||
}
|
||
|
||
return txBlock.BlockHash, txBlock.BlockIndex, txBlock.Index, nil
|
||
}
|
||
|
||
// GetTransactionByHash returns the transaction for the given hash
|
||
func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) (*RPCTransaction, error) {
|
||
var tx *types.Transaction
|
||
var isPending bool
|
||
var err error
|
||
|
||
if tx, isPending, err = getTransaction(s.b.ChainDb(), s.b, hash); err != nil {
|
||
log.Debug("Failed to retrieve transaction", "hash", hash, "err", err)
|
||
return nil, nil
|
||
} else if tx == nil {
|
||
return nil, nil
|
||
}
|
||
if isPending {
|
||
return newRPCPendingTransaction(tx), nil
|
||
}
|
||
|
||
blockHash, _, _, err := getTransactionBlockData(s.b.ChainDb(), hash)
|
||
if err != nil {
|
||
log.Debug("Failed to retrieve transaction block", "hash", hash, "err", err)
|
||
return nil, nil
|
||
}
|
||
|
||
if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
|
||
return newRPCTransaction(block, hash)
|
||
}
|
||
return nil, nil
|
||
}
|
||
|
||
// GetRawTransactionByHash returns the bytes of the transaction for the given hash.
|
||
func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
|
||
var tx *types.Transaction
|
||
var err error
|
||
|
||
if tx, _, err = getTransaction(s.b.ChainDb(), s.b, hash); err != nil {
|
||
log.Debug("Failed to retrieve transaction", "hash", hash, "err", err)
|
||
return nil, nil
|
||
} else if tx == nil {
|
||
return nil, nil
|
||
}
|
||
|
||
return rlp.EncodeToBytes(tx)
|
||
}
|
||
|
||
// GetTransactionReceipt returns the transaction receipt for the given transaction hash.
|
||
func (s *PublicTransactionPoolAPI) GetTransactionReceipt(hash common.Hash) (map[string]interface{}, error) {
|
||
receipt := core.GetReceipt(s.b.ChainDb(), hash)
|
||
if receipt == nil {
|
||
log.Debug("Receipt not found for transaction", "hash", hash)
|
||
return nil, nil
|
||
}
|
||
|
||
tx, _, err := getTransaction(s.b.ChainDb(), s.b, hash)
|
||
if err != nil {
|
||
log.Debug("Failed to retrieve transaction", "hash", hash, "err", err)
|
||
return nil, nil
|
||
}
|
||
|
||
txBlock, blockIndex, index, err := getTransactionBlockData(s.b.ChainDb(), hash)
|
||
if err != nil {
|
||
log.Debug("Failed to retrieve transaction block", "hash", hash, "err", err)
|
||
return nil, nil
|
||
}
|
||
|
||
var signer types.Signer = types.FrontierSigner{}
|
||
if tx.Protected() {
|
||
signer = types.NewEIP155Signer(tx.ChainId())
|
||
}
|
||
from, _ := types.Sender(signer, tx)
|
||
|
||
fields := map[string]interface{}{
|
||
"root": hexutil.Bytes(receipt.PostState),
|
||
"blockHash": txBlock,
|
||
"blockNumber": hexutil.Uint64(blockIndex),
|
||
"transactionHash": hash,
|
||
"transactionIndex": hexutil.Uint64(index),
|
||
"from": from,
|
||
"to": tx.To(),
|
||
"gasUsed": (*hexutil.Big)(receipt.GasUsed),
|
||
"cumulativeGasUsed": (*hexutil.Big)(receipt.CumulativeGasUsed),
|
||
"contractAddress": nil,
|
||
"logs": receipt.Logs,
|
||
"logsBloom": receipt.Bloom,
|
||
}
|
||
if receipt.Logs == nil {
|
||
fields["logs"] = [][]*types.Log{}
|
||
}
|
||
// If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
|
||
if receipt.ContractAddress != (common.Address{}) {
|
||
fields["contractAddress"] = receipt.ContractAddress
|
||
}
|
||
return fields, nil
|
||
}
|
||
|
||
// sign is a helper function that signs a transaction with the private key of the given address.
|
||
func (s *PublicTransactionPoolAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) {
|
||
// Look up the wallet containing the requested signer
|
||
account := accounts.Account{Address: addr}
|
||
|
||
wallet, err := s.b.AccountManager().Find(account)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
// Request the wallet to sign the transaction
|
||
var chainID *big.Int
|
||
if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
|
||
chainID = config.ChainId
|
||
}
|
||
return wallet.SignTx(account, tx, chainID)
|
||
}
|
||
|
||
// SendTxArgs represents the arguments to sumbit a new transaction into the transaction pool.
|
||
type SendTxArgs struct {
|
||
From common.Address `json:"from"`
|
||
To *common.Address `json:"to"`
|
||
Gas *hexutil.Big `json:"gas"`
|
||
GasPrice *hexutil.Big `json:"gasPrice"`
|
||
Value *hexutil.Big `json:"value"`
|
||
Data hexutil.Bytes `json:"data"`
|
||
Nonce *hexutil.Uint64 `json:"nonce"`
|
||
}
|
||
|
||
// prepareSendTxArgs is a helper function that fills in default values for unspecified tx fields.
|
||
func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
|
||
if args.Gas == nil {
|
||
args.Gas = (*hexutil.Big)(big.NewInt(defaultGas))
|
||
}
|
||
if args.GasPrice == nil {
|
||
price, err := b.SuggestPrice(ctx)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
args.GasPrice = (*hexutil.Big)(price)
|
||
}
|
||
if args.Value == nil {
|
||
args.Value = new(hexutil.Big)
|
||
}
|
||
if args.Nonce == nil {
|
||
nonce, err := b.GetPoolNonce(ctx, args.From)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
args.Nonce = (*hexutil.Uint64)(&nonce)
|
||
}
|
||
return nil
|
||
}
|
||
|
||
func (args *SendTxArgs) toTransaction() *types.Transaction {
|
||
if args.To == nil {
|
||
return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), (*big.Int)(args.Gas), (*big.Int)(args.GasPrice), args.Data)
|
||
}
|
||
return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), (*big.Int)(args.Gas), (*big.Int)(args.GasPrice), args.Data)
|
||
}
|
||
|
||
// submitTransaction is a helper function that submits tx to txPool and logs a message.
|
||
func submitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) {
|
||
if err := b.SendTx(ctx, tx); err != nil {
|
||
return common.Hash{}, err
|
||
}
|
||
if tx.To() == nil {
|
||
signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
|
||
from, _ := types.Sender(signer, tx)
|
||
addr := crypto.CreateAddress(from, tx.Nonce())
|
||
log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
|
||
} else {
|
||
log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
|
||
}
|
||
return tx.Hash(), nil
|
||
}
|
||
|
||
// SendTransaction creates a transaction for the given argument, sign it and submit it to the
|
||
// transaction pool.
|
||
func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args SendTxArgs) (common.Hash, error) {
|
||
// Set some sanity defaults and terminate on failure
|
||
if err := args.setDefaults(ctx, s.b); err != nil {
|
||
return common.Hash{}, err
|
||
}
|
||
// Look up the wallet containing the requested signer
|
||
account := accounts.Account{Address: args.From}
|
||
|
||
wallet, err := s.b.AccountManager().Find(account)
|
||
if err != nil {
|
||
return common.Hash{}, err
|
||
}
|
||
// Assemble the transaction and sign with the wallet
|
||
tx := args.toTransaction()
|
||
|
||
var chainID *big.Int
|
||
if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
|
||
chainID = config.ChainId
|
||
}
|
||
signed, err := wallet.SignTx(account, tx, chainID)
|
||
if err != nil {
|
||
return common.Hash{}, err
|
||
}
|
||
return submitTransaction(ctx, s.b, signed)
|
||
}
|
||
|
||
// SendRawTransaction will add the signed transaction to the transaction pool.
|
||
// The sender is responsible for signing the transaction and using the correct nonce.
|
||
func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (string, error) {
|
||
tx := new(types.Transaction)
|
||
if err := rlp.DecodeBytes(encodedTx, tx); err != nil {
|
||
return "", err
|
||
}
|
||
|
||
if err := s.b.SendTx(ctx, tx); err != nil {
|
||
return "", err
|
||
}
|
||
|
||
signer := types.MakeSigner(s.b.ChainConfig(), s.b.CurrentBlock().Number())
|
||
if tx.To() == nil {
|
||
from, err := types.Sender(signer, tx)
|
||
if err != nil {
|
||
return "", err
|
||
}
|
||
addr := crypto.CreateAddress(from, tx.Nonce())
|
||
log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
|
||
} else {
|
||
log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
|
||
}
|
||
|
||
return tx.Hash().Hex(), nil
|
||
}
|
||
|
||
// Sign calculates an ECDSA signature for:
|
||
// keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
|
||
//
|
||
// Note, the produced signature conforms to the secp256k1 curve R, S and V values,
|
||
// where the V value will be 27 or 28 for legacy reasons.
|
||
//
|
||
// The account associated with addr must be unlocked.
|
||
//
|
||
// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
|
||
func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
|
||
// Look up the wallet containing the requested signer
|
||
account := accounts.Account{Address: addr}
|
||
|
||
wallet, err := s.b.AccountManager().Find(account)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
// Sign the requested hash with the wallet
|
||
signature, err := wallet.SignHash(account, signHash(data))
|
||
if err == nil {
|
||
signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
|
||
}
|
||
return signature, err
|
||
}
|
||
|
||
// SignTransactionResult represents a RLP encoded signed transaction.
|
||
type SignTransactionResult struct {
|
||
Raw hexutil.Bytes `json:"raw"`
|
||
Tx *types.Transaction `json:"tx"`
|
||
}
|
||
|
||
// SignTransaction will sign the given transaction with the from account.
|
||
// The node needs to have the private key of the account corresponding with
|
||
// the given from address and it needs to be unlocked.
|
||
func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
|
||
if err := args.setDefaults(ctx, s.b); err != nil {
|
||
return nil, err
|
||
}
|
||
tx, err := s.sign(args.From, args.toTransaction())
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
data, err := rlp.EncodeToBytes(tx)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
return &SignTransactionResult{data, tx}, nil
|
||
}
|
||
|
||
// PendingTransactions returns the transactions that are in the transaction pool and have a from address that is one of
|
||
// the accounts this node manages.
|
||
func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
|
||
pending, err := s.b.GetPoolTransactions()
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
|
||
transactions := make([]*RPCTransaction, 0, len(pending))
|
||
for _, tx := range pending {
|
||
var signer types.Signer = types.HomesteadSigner{}
|
||
if tx.Protected() {
|
||
signer = types.NewEIP155Signer(tx.ChainId())
|
||
}
|
||
from, _ := types.Sender(signer, tx)
|
||
if _, err := s.b.AccountManager().Find(accounts.Account{Address: from}); err == nil {
|
||
transactions = append(transactions, newRPCPendingTransaction(tx))
|
||
}
|
||
}
|
||
return transactions, nil
|
||
}
|
||
|
||
// Resend accepts an existing transaction and a new gas price and limit. It will remove
|
||
// the given transaction from the pool and reinsert it with the new gas price and limit.
|
||
func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice, gasLimit *hexutil.Big) (common.Hash, error) {
|
||
if sendArgs.Nonce == nil {
|
||
return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec")
|
||
}
|
||
if err := sendArgs.setDefaults(ctx, s.b); err != nil {
|
||
return common.Hash{}, err
|
||
}
|
||
matchTx := sendArgs.toTransaction()
|
||
pending, err := s.b.GetPoolTransactions()
|
||
if err != nil {
|
||
return common.Hash{}, err
|
||
}
|
||
|
||
for _, p := range pending {
|
||
var signer types.Signer = types.HomesteadSigner{}
|
||
if p.Protected() {
|
||
signer = types.NewEIP155Signer(p.ChainId())
|
||
}
|
||
wantSigHash := signer.Hash(matchTx)
|
||
|
||
if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash {
|
||
// Match. Re-sign and send the transaction.
|
||
if gasPrice != nil {
|
||
sendArgs.GasPrice = gasPrice
|
||
}
|
||
if gasLimit != nil {
|
||
sendArgs.Gas = gasLimit
|
||
}
|
||
signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())
|
||
if err != nil {
|
||
return common.Hash{}, err
|
||
}
|
||
s.b.RemoveTx(p.Hash())
|
||
if err = s.b.SendTx(ctx, signedTx); err != nil {
|
||
return common.Hash{}, err
|
||
}
|
||
return signedTx.Hash(), nil
|
||
}
|
||
}
|
||
|
||
return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash())
|
||
}
|
||
|
||
// PublicDebugAPI is the collection of Etheruem APIs exposed over the public
|
||
// debugging endpoint.
|
||
type PublicDebugAPI struct {
|
||
b Backend
|
||
}
|
||
|
||
// NewPublicDebugAPI creates a new API definition for the public debug methods
|
||
// of the Ethereum service.
|
||
func NewPublicDebugAPI(b Backend) *PublicDebugAPI {
|
||
return &PublicDebugAPI{b: b}
|
||
}
|
||
|
||
// GetBlockRlp retrieves the RLP encoded for of a single block.
|
||
func (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) {
|
||
block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
|
||
if block == nil {
|
||
return "", fmt.Errorf("block #%d not found", number)
|
||
}
|
||
encoded, err := rlp.EncodeToBytes(block)
|
||
if err != nil {
|
||
return "", err
|
||
}
|
||
return fmt.Sprintf("%x", encoded), nil
|
||
}
|
||
|
||
// PrintBlock retrieves a block and returns its pretty printed form.
|
||
func (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) {
|
||
block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
|
||
if block == nil {
|
||
return "", fmt.Errorf("block #%d not found", number)
|
||
}
|
||
return fmt.Sprintf("%s", block), nil
|
||
}
|
||
|
||
// SeedHash retrieves the seed hash of a block.
|
||
func (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) {
|
||
block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
|
||
if block == nil {
|
||
return "", fmt.Errorf("block #%d not found", number)
|
||
}
|
||
return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil
|
||
}
|
||
|
||
// PrivateDebugAPI is the collection of Etheruem APIs exposed over the private
|
||
// debugging endpoint.
|
||
type PrivateDebugAPI struct {
|
||
b Backend
|
||
}
|
||
|
||
// NewPrivateDebugAPI creates a new API definition for the private debug methods
|
||
// of the Ethereum service.
|
||
func NewPrivateDebugAPI(b Backend) *PrivateDebugAPI {
|
||
return &PrivateDebugAPI{b: b}
|
||
}
|
||
|
||
// ChaindbProperty returns leveldb properties of the chain database.
|
||
func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) {
|
||
ldb, ok := api.b.ChainDb().(interface {
|
||
LDB() *leveldb.DB
|
||
})
|
||
if !ok {
|
||
return "", fmt.Errorf("chaindbProperty does not work for memory databases")
|
||
}
|
||
if property == "" {
|
||
property = "leveldb.stats"
|
||
} else if !strings.HasPrefix(property, "leveldb.") {
|
||
property = "leveldb." + property
|
||
}
|
||
return ldb.LDB().GetProperty(property)
|
||
}
|
||
|
||
func (api *PrivateDebugAPI) ChaindbCompact() error {
|
||
ldb, ok := api.b.ChainDb().(interface {
|
||
LDB() *leveldb.DB
|
||
})
|
||
if !ok {
|
||
return fmt.Errorf("chaindbCompact does not work for memory databases")
|
||
}
|
||
for b := byte(0); b < 255; b++ {
|
||
log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
|
||
err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}})
|
||
if err != nil {
|
||
log.Error("Database compaction failed", "err", err)
|
||
return err
|
||
}
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// SetHead rewinds the head of the blockchain to a previous block.
|
||
func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
|
||
api.b.SetHead(uint64(number))
|
||
}
|
||
|
||
// PublicNetAPI offers network related RPC methods
|
||
type PublicNetAPI struct {
|
||
net *p2p.Server
|
||
networkVersion int
|
||
}
|
||
|
||
// NewPublicNetAPI creates a new net API instance.
|
||
func NewPublicNetAPI(net *p2p.Server, networkVersion int) *PublicNetAPI {
|
||
return &PublicNetAPI{net, networkVersion}
|
||
}
|
||
|
||
// Listening returns an indication if the node is listening for network connections.
|
||
func (s *PublicNetAPI) Listening() bool {
|
||
return true // always listening
|
||
}
|
||
|
||
// PeerCount returns the number of connected peers
|
||
func (s *PublicNetAPI) PeerCount() hexutil.Uint {
|
||
return hexutil.Uint(s.net.PeerCount())
|
||
}
|
||
|
||
// Version returns the current ethereum protocol version.
|
||
func (s *PublicNetAPI) Version() string {
|
||
return fmt.Sprintf("%d", s.networkVersion)
|
||
}
|