status-go/vendor/github.com/ethereum/go-ethereum/internal/ethapi/api.go

1471 lines
52 KiB
Go
Raw Normal View History

2016-11-25 05:50:30 +00:00
// Copyright 2015 The go-ethereum Authors
2016-07-03 19:44:31 +00:00
// This file is part of the go-ethereum library.
2016-06-20 14:47:10 +00:00
//
2016-07-03 19:44:31 +00:00
// 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
2016-06-20 14:47:10 +00:00
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
2016-07-03 19:44:31 +00:00
// The go-ethereum library is distributed in the hope that it will be useful,
2016-06-20 14:47:10 +00:00
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2016-07-03 19:44:31 +00:00
// GNU Lesser General Public License for more details.
2016-06-20 14:47:10 +00:00
//
2016-07-03 19:44:31 +00:00
// 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/>.
2016-06-20 14:47:10 +00:00
package ethapi
import (
"bytes"
"context"
2017-02-23 02:18:01 +00:00
"errors"
2016-06-20 14:47:10 +00:00
"fmt"
"math/big"
"strings"
"time"
"github.com/ethereum/go-ethereum/accounts"
2017-02-27 12:40:42 +00:00
"github.com/ethereum/go-ethereum/accounts/keystore"
2016-06-20 14:47:10 +00:00
"github.com/ethereum/go-ethereum/common"
2017-02-23 00:22:43 +00:00
"github.com/ethereum/go-ethereum/common/hexutil"
"github.com/ethereum/go-ethereum/common/math"
"github.com/ethereum/go-ethereum/consensus/ethash"
2016-06-20 14:47:10 +00:00
"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/log"
2016-06-20 14:47:10 +00:00
"github.com/ethereum/go-ethereum/p2p"
"github.com/ethereum/go-ethereum/params"
2016-06-20 14:47:10 +00:00
"github.com/ethereum/go-ethereum/rlp"
"github.com/ethereum/go-ethereum/rpc"
"github.com/syndtr/goleveldb/leveldb"
2016-11-25 05:50:30 +00:00
"github.com/syndtr/goleveldb/leveldb/util"
2016-06-20 14:47:10 +00:00
)
const (
defaultGasPrice = 50 * params.Shannon
)
2016-06-20 14:47:10 +00:00
// 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
2016-06-20 14:47:10 +00:00
}
2017-10-17 09:58:04 +00:00
// NewPublicEthereumAPI creates a new Ethereum protocol API.
func NewPublicEthereumAPI(b Backend) *PublicEthereumAPI {
return &PublicEthereumAPI{b}
2016-06-20 14:47:10 +00:00
}
// 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
2017-02-23 00:22:43 +00:00
func (s *PublicEthereumAPI) ProtocolVersion() hexutil.Uint {
return hexutil.Uint(s.b.ProtocolVersion())
2016-06-20 14:47:10 +00:00
}
// 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()
2016-06-20 14:47:10 +00:00
// Return not syncing if the synchronisation already completed
if progress.CurrentBlock >= progress.HighestBlock {
2016-06-20 14:47:10 +00:00
return false, nil
}
// Otherwise gather the block sync stats
return map[string]interface{}{
2017-02-23 00:22:43 +00:00
"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),
2016-06-20 14:47:10 +00:00
}, 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),
2016-06-20 14:47:10 +00:00
}
pending, queue := s.b.TxPoolContent()
// Flatten the pending transactions
for account, txs := range pending {
dump := make(map[string]*RPCTransaction)
for _, tx := range txs {
dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx)
2016-06-20 14:47:10 +00:00
}
content["pending"][account.Hex()] = dump
}
// Flatten the queued transactions
for account, txs := range queue {
dump := make(map[string]*RPCTransaction)
for _, tx := range txs {
dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx)
2016-06-20 14:47:10 +00:00
}
content["queued"][account.Hex()] = dump
}
return content
}
// Status returns the number of pending and queued transaction in the pool.
2017-02-23 00:22:43 +00:00
func (s *PublicTxPoolAPI) Status() map[string]hexutil.Uint {
2016-06-20 14:47:10 +00:00
pending, queue := s.b.Stats()
2017-02-23 00:22:43 +00:00
return map[string]hexutil.Uint{
"pending": hexutil.Uint(pending),
"queued": hexutil.Uint(queue),
2016-06-20 14:47:10 +00:00
}
}
// 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),
2016-06-20 14:47:10 +00:00
}
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 gas × %v wei", tx.To().Hex(), tx.Value(), tx.Gas(), tx.GasPrice())
2016-06-20 14:47:10 +00:00
}
return fmt.Sprintf("contract creation: %v wei + %v gas × %v wei", tx.Value(), tx.Gas(), tx.GasPrice())
2016-06-20 14:47:10 +00:00
}
// Flatten the pending transactions
for account, txs := range pending {
dump := make(map[string]string)
for _, tx := range txs {
dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx)
2016-06-20 14:47:10 +00:00
}
content["pending"][account.Hex()] = dump
}
// Flatten the queued transactions
for account, txs := range queue {
dump := make(map[string]string)
for _, tx := range txs {
dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx)
2016-06-20 14:47:10 +00:00
}
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}
2016-06-20 14:47:10 +00:00
}
// Accounts returns the collection of accounts this node manages
2017-02-27 12:40:42 +00:00
func (s *PublicAccountAPI) Accounts() []common.Address {
addresses := make([]common.Address, 0) // return [] instead of nil if empty
2017-02-27 12:40:42 +00:00
for _, wallet := range s.am.Wallets() {
for _, account := range wallet.Accounts() {
addresses = append(addresses, account.Address)
}
}
return addresses
2016-06-20 14:47:10 +00:00
}
// PrivateAccountAPI provides an API to access accounts managed by this node.
2016-07-03 19:44:31 +00:00
// It offers methods to create, (un)lock en list accounts. Some methods accept
// passwords and are therefore considered private by default.
2016-06-20 14:47:10 +00:00
type PrivateAccountAPI struct {
am *accounts.Manager
nonceLock *AddrLocker
b Backend
2016-06-20 14:47:10 +00:00
}
// NewPrivateAccountAPI create a new PrivateAccountAPI.
func NewPrivateAccountAPI(b Backend, nonceLock *AddrLocker) *PrivateAccountAPI {
2016-07-03 19:44:31 +00:00
return &PrivateAccountAPI{
am: b.AccountManager(),
nonceLock: nonceLock,
b: b,
2016-07-03 19:44:31 +00:00
}
2016-06-20 14:47:10 +00:00
}
func NewSubsetOfPrivateAccountAPI(am *accounts.Manager) *PrivateAccountAPI {
return &PrivateAccountAPI{
am: am,
nonceLock: nil,
b: nil,
}
}
2016-06-20 14:47:10 +00:00
// 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
2017-02-27 12:40:42 +00:00
for _, wallet := range s.am.Wallets() {
for _, account := range wallet.Accounts() {
addresses = append(addresses, account.Address)
}
2016-06-20 14:47:10 +00:00
}
return addresses
}
2017-02-27 12:40:42 +00:00
// 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"`
2017-10-10 09:38:49 +00:00
Failure string `json:"failure,omitempty"`
Accounts []accounts.Account `json:"accounts,omitempty"`
2017-02-27 12:40:42 +00:00
}
// 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
2017-02-27 12:40:42 +00:00
for _, wallet := range s.am.Wallets() {
2017-10-10 09:38:49 +00:00
status, failure := wallet.Status()
raw := rawWallet{
2017-02-27 12:40:42 +00:00
URL: wallet.URL().String(),
2017-10-10 09:38:49 +00:00
Status: status,
2017-02-27 12:40:42 +00:00
Accounts: wallet.Accounts(),
2017-10-10 09:38:49 +00:00
}
if failure != nil {
raw.Failure = failure.Error()
}
wallets = append(wallets, raw)
2017-02-27 12:40:42 +00:00
}
return wallets
}
2017-10-10 09:38:49 +00:00
// OpenWallet initiates a hardware wallet opening procedure, establishing a USB
// connection and attempting to authenticate via the provided passphrase. Note,
// the method may return an extra challenge requiring a second open (e.g. the
// Trezor PIN matrix challenge).
func (s *PrivateAccountAPI) OpenWallet(url string, passphrase *string) error {
wallet, err := s.am.Wallet(url)
if err != nil {
return err
}
pass := ""
if passphrase != nil {
pass = *passphrase
}
return wallet.Open(pass)
}
2017-02-27 12:40:42 +00:00
// 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)
}
2016-06-20 14:47:10 +00:00
// NewAccount will create a new account and returns the address for the new account.
2017-10-10 09:38:49 +00:00
func (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) {
acc, err := fetchKeystore(s.am).NewAccount(password)
2016-06-20 14:47:10 +00:00
if err == nil {
return acc.Address, nil
}
return common.Address{}, err
}
2017-02-27 12:40:42 +00:00
// fetchKeystore retrives the encrypted keystore from the account manager.
func fetchKeystore(am *accounts.Manager) *keystore.KeyStore {
return am.Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
}
2016-07-03 19:44:31 +00:00
// ImportRawKey stores the given hex encoded ECDSA key into the key directory,
// encrypting it with the passphrase.
2016-06-20 14:47:10 +00:00
func (s *PrivateAccountAPI) ImportRawKey(privkey string, password string) (common.Address, error) {
key, err := crypto.HexToECDSA(privkey)
2016-06-20 14:47:10 +00:00
if err != nil {
return common.Address{}, err
}
acc, err := fetchKeystore(s.am).ImportECDSA(key, password)
2016-06-20 14:47:10 +00:00
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.
2017-02-23 02:18:01 +00:00
func (s *PrivateAccountAPI) UnlockAccount(addr common.Address, password string, duration *uint64) (bool, error) {
const max = uint64(time.Duration(math.MaxInt64) / time.Second)
2017-02-23 00:22:43 +00:00
var d time.Duration
2016-06-20 14:47:10 +00:00
if duration == nil {
2017-02-23 00:22:43 +00:00
d = 300 * time.Second
2017-02-23 02:18:01 +00:00
} else if *duration > max {
return false, errors.New("unlock duration too large")
2017-02-23 00:22:43 +00:00
} else {
d = time.Duration(*duration) * time.Second
2016-06-20 14:47:10 +00:00
}
2017-02-27 12:40:42 +00:00
err := fetchKeystore(s.am).TimedUnlock(accounts.Account{Address: addr}, password, d)
2017-02-23 02:18:01 +00:00
return err == nil, err
2016-06-20 14:47:10 +00:00
}
// LockAccount will lock the account associated with the given address when it's unlocked.
func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool {
2017-02-27 12:40:42 +00:00
return fetchKeystore(s.am).Lock(addr) == nil
2016-06-20 14:47:10 +00:00
}
// signTransactions sets defaults and signs the given transaction
// NOTE: the caller needs to ensure that the nonceLock is held, if applicable,
// and release it after the transaction has been submitted to the tx pool
func (s *PrivateAccountAPI) signTransaction(ctx context.Context, args SendTxArgs, passwd string) (*types.Transaction, error) {
2017-02-27 12:40:42 +00:00
// Look up the wallet containing the requested signer
account := accounts.Account{Address: args.From}
wallet, err := s.am.Find(account)
2016-07-03 19:44:31 +00:00
if err != nil {
return nil, err
}
// Set some sanity defaults and terminate on failure
if err := args.setDefaults(ctx, s.b); err != nil {
return nil, err
}
2017-02-27 12:40:42 +00:00
// Assemble the transaction and sign with the wallet
tx := args.toTransaction()
2016-07-03 19:44:31 +00:00
2017-02-27 12:40:42 +00:00
var chainID *big.Int
if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
chainID = config.ChainId
}
return wallet.SignTxWithPassphrase(account, passwd, tx, chainID)
}
// 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) {
if args.Nonce == nil {
// Hold the addresse's mutex around signing to prevent concurrent assignment of
// the same nonce to multiple accounts.
s.nonceLock.LockAddr(args.From)
defer s.nonceLock.UnlockAddr(args.From)
}
signed, err := s.signTransaction(ctx, args, passwd)
2017-02-27 12:40:42 +00:00
if err != nil {
return common.Hash{}, err
}
return submitTransaction(ctx, s.b, signed)
2016-07-03 19:44:31 +00:00
}
// SignTransaction 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. The transaction is returned in RLP-form, not broadcast
// to other nodes
func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args SendTxArgs, passwd string) (*SignTransactionResult, error) {
// No need to obtain the noncelock mutex, since we won't be sending this
// tx into the transaction pool, but right back to the user
if args.Gas == nil {
return nil, fmt.Errorf("gas not specified")
}
if args.GasPrice == nil {
return nil, fmt.Errorf("gasPrice not specified")
}
if args.Nonce == nil {
return nil, fmt.Errorf("nonce not specified")
}
signed, err := s.signTransaction(ctx, args, passwd)
if err != nil {
return nil, err
}
data, err := rlp.EncodeToBytes(signed)
if err != nil {
return nil, err
}
return &SignTransactionResult{data, signed}, nil
}
2016-11-25 05:50:30 +00:00
// signHash is a helper function that calculates a hash for the given message that can be
2017-02-23 00:22:43 +00:00
// 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 {
2016-11-25 05:50:30 +00:00
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))
//
2017-02-23 00:22:43 +00:00
// 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.
//
2016-11-25 05:50:30 +00:00
// The key used to calculate the signature is decrypted with the given password.
//
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign
2017-02-23 00:22:43 +00:00
func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {
2017-02-27 12:40:42 +00:00
// Look up the wallet containing the requested signer
account := accounts.Account{Address: addr}
wallet, err := s.am.Find(account)
2017-02-27 12:40:42 +00:00
if err != nil {
return nil, err
}
// Assemble sign the data with the wallet
signature, err := wallet.SignHashWithPassphrase(account, passwd, signHash(data))
2016-11-25 05:50:30 +00:00
if err != nil {
2017-02-23 00:22:43 +00:00
return nil, err
2016-11-25 05:50:30 +00:00
}
2017-02-23 00:22:43 +00:00
signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
return signature, nil
2016-11-25 05:50:30 +00:00
}
// 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)
//
2017-02-23 00:22:43 +00:00
// 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.
//
2016-11-25 05:50:30 +00:00
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover
2017-02-23 00:22:43 +00:00
func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {
2016-11-25 05:50:30 +00:00
if len(sig) != 65 {
return common.Address{}, fmt.Errorf("signature must be 65 bytes long")
}
2017-02-23 00:22:43 +00:00
if sig[64] != 27 && sig[64] != 28 {
return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)")
2016-11-25 05:50:30 +00:00
}
2017-02-23 00:22:43 +00:00
sig[64] -= 27 // Transform yellow paper V from 27/28 to 0/1
2016-11-25 05:50:30 +00:00
2017-02-23 00:22:43 +00:00
rpk, err := crypto.Ecrecover(signHash(data), sig)
2016-11-25 05:50:30 +00:00
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)
}
2016-06-20 14:47:10 +00:00
// 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
2016-06-20 14:47:10 +00:00
}
2017-10-17 09:58:04 +00:00
// NewPublicBlockChainAPI creates a new Ethereum blockchain API.
2016-06-20 14:47:10 +00:00
func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI {
return &PublicBlockChainAPI{b}
2016-06-20 14:47:10 +00:00
}
// 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
2016-06-20 14:47:10 +00:00
}
// 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)
2016-06-20 14:47:10 +00:00
if state == nil || err != nil {
return nil, err
}
b := state.GetBalance(address)
return b, state.Error()
2016-06-20 14:47:10 +00:00
}
// 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"} {
2016-06-20 14:47:10 +00:00
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.
2017-02-23 00:22:43 +00:00
func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {
2016-06-20 14:47:10 +00:00
block, err := s.b.BlockByNumber(ctx, blockNr)
if block != nil {
uncles := block.Uncles()
2017-02-23 00:22:43 +00:00
if index >= hexutil.Uint(len(uncles)) {
log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index)
2016-06-20 14:47:10 +00:00
return nil, nil
}
2017-02-23 00:22:43 +00:00
block = types.NewBlockWithHeader(uncles[index])
2016-06-20 14:47:10 +00:00
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.
2017-02-23 00:22:43 +00:00
func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {
2016-06-20 14:47:10 +00:00
block, err := s.b.GetBlock(ctx, blockHash)
if block != nil {
uncles := block.Uncles()
2017-02-23 00:22:43 +00:00
if index >= hexutil.Uint(len(uncles)) {
log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index)
2016-06-20 14:47:10 +00:00
return nil, nil
}
2017-02-23 00:22:43 +00:00
block = types.NewBlockWithHeader(uncles[index])
2016-06-20 14:47:10 +00:00
return s.rpcOutputBlock(block, false, false)
}
return nil, err
}
// GetUncleCountByBlockNumber returns number of uncles in the block for the given block number
2017-02-23 00:22:43 +00:00
func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
2016-06-20 14:47:10 +00:00
if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
2017-02-23 00:22:43 +00:00
n := hexutil.Uint(len(block.Uncles()))
return &n
2016-06-20 14:47:10 +00:00
}
return nil
}
// GetUncleCountByBlockHash returns number of uncles in the block for the given block hash
2017-02-23 00:22:43 +00:00
func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
2016-06-20 14:47:10 +00:00
if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
2017-02-23 00:22:43 +00:00
n := hexutil.Uint(len(block.Uncles()))
return &n
2016-06-20 14:47:10 +00:00
}
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) (hexutil.Bytes, error) {
state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
2016-06-20 14:47:10 +00:00
if state == nil || err != nil {
return nil, err
2016-06-20 14:47:10 +00:00
}
code := state.GetCode(address)
return code, state.Error()
2016-06-20 14:47:10 +00:00
}
// 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) (hexutil.Bytes, error) {
state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
2016-06-20 14:47:10 +00:00
if state == nil || err != nil {
return nil, err
2016-06-20 14:47:10 +00:00
}
res := state.GetState(address, common.HexToHash(key))
return res[:], state.Error()
2016-06-20 14:47:10 +00:00
}
2016-07-03 19:44:31 +00:00
// CallArgs represents the arguments for a call.
2016-06-20 14:47:10 +00:00
type CallArgs struct {
From common.Address `json:"from"`
To *common.Address `json:"to"`
Gas hexutil.Uint64 `json:"gas"`
2017-02-23 00:22:43 +00:00
GasPrice hexutil.Big `json:"gasPrice"`
Value hexutil.Big `json:"value"`
Data hexutil.Bytes `json:"data"`
2016-06-20 14:47:10 +00:00
}
func (s *PublicBlockChainAPI) doCall(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber, vmCfg vm.Config) ([]byte, uint64, bool, 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)
2016-07-03 19:44:31 +00:00
if state == nil || err != nil {
return nil, 0, false, err
2016-07-03 19:44:31 +00:00
}
2017-02-27 12:40:42 +00:00
// 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
}
2016-06-20 14:47:10 +00:00
}
2016-07-03 19:44:31 +00:00
}
2017-02-27 12:40:42 +00:00
// Set default gas & gas price if none were set
gas, gasPrice := uint64(args.Gas), args.GasPrice.ToInt()
if gas == 0 {
gas = 50000000
2016-07-03 19:44:31 +00:00
}
if gasPrice.Sign() == 0 {
gasPrice = new(big.Int).SetUint64(defaultGasPrice)
2016-06-20 14:47:10 +00:00
}
// Create new call message
2017-02-23 00:22:43 +00:00
msg := types.NewMessage(addr, args.To, 0, args.Value.ToInt(), gas, gasPrice, args.Data, false)
2016-06-20 14:47:10 +00:00
// 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)
2016-07-03 19:44:31 +00:00
}
// 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, 0, false, 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() {
2017-10-10 09:38:49 +00:00
<-ctx.Done()
evm.Cancel()
}()
// Setup the gas pool (also for unmetered requests)
// and apply the message.
gp := new(core.GasPool).AddGas(math.MaxUint64)
2017-10-17 09:58:04 +00:00
res, gas, failed, err := core.ApplyMessage(evm, msg, gp)
2016-07-03 19:44:31 +00:00
if err := vmError(); err != nil {
return nil, 0, false, err
2016-07-03 19:44:31 +00:00
}
2017-10-17 09:58:04 +00:00
return res, gas, failed, err
2016-06-20 14:47:10 +00:00
}
// Call executes the given transaction on the state for the given block number.
2017-02-23 00:22:43 +00:00
// 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) {
2017-10-17 09:58:04 +00:00
result, _, _, err := s.doCall(ctx, args, blockNr, vm.Config{DisableGasMetering: true})
return (hexutil.Bytes)(result), err
2016-06-20 14:47:10 +00:00
}
// EstimateGas returns an estimate of the amount of gas needed to execute the
// given transaction against the current pending block.
func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (hexutil.Uint64, error) {
// Binary search the gas requirement, as it may be higher than the amount used
2017-10-17 09:58:04 +00:00
var (
lo uint64 = params.TxGas - 1
hi uint64
cap uint64
2017-10-17 09:58:04 +00:00
)
if uint64(args.Gas) >= params.TxGas {
hi = uint64(args.Gas)
2017-02-23 17:24:40 +00:00
} else {
// Retrieve the current pending block to act as the gas ceiling
block, err := s.b.BlockByNumber(ctx, rpc.PendingBlockNumber)
if err != nil {
return 0, err
2017-02-23 17:24:40 +00:00
}
hi = block.GasLimit()
2017-02-23 17:24:40 +00:00
}
cap = hi
2017-02-23 17:24:40 +00:00
// Create a helper to check if a gas allowance results in an executable transaction
executable := func(gas uint64) bool {
args.Gas = hexutil.Uint64(gas)
2017-10-17 09:58:04 +00:00
_, _, failed, err := s.doCall(ctx, args, rpc.PendingBlockNumber, vm.Config{})
if err != nil || failed {
return false
}
return true
}
// Execute the binary search and hone in on an executable gas limit
for lo+1 < hi {
mid := (hi + lo) / 2
if !executable(mid) {
2017-02-23 17:24:40 +00:00
lo = mid
} else {
hi = mid
}
}
// Reject the transaction as invalid if it still fails at the highest allowance
if hi == cap {
if !executable(hi) {
return 0, fmt.Errorf("gas required exceeds allowance or always failing transaction")
2017-02-23 17:24:40 +00:00
}
}
return hexutil.Uint64(hi), nil
2016-06-20 14:47:10 +00:00
}
// ExecutionResult groups all structured logs emitted by the EVM
2017-10-17 09:58:04 +00:00
// while replaying a transaction in debug mode as well as transaction
// execution status, the amount of gas used and the return value
2016-06-20 14:47:10 +00:00
type ExecutionResult struct {
Gas uint64 `json:"gas"`
2017-10-17 09:58:04 +00:00
Failed bool `json:"failed"`
2016-06-20 14:47:10 +00:00
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,omitempty"`
Stack *[]string `json:"stack,omitempty"`
Memory *[]string `json:"memory,omitempty"`
Storage *map[string]string `json:"storage,omitempty"`
2016-06-20 14:47:10 +00:00
}
// formatLogs formats EVM returned structured logs for json output
func FormatLogs(logs []vm.StructLog) []StructLogRes {
formatted := make([]StructLogRes, len(logs))
for index, trace := range logs {
formatted[index] = StructLogRes{
2016-06-20 14:47:10 +00:00
Pc: trace.Pc,
Op: trace.Op.String(),
Gas: trace.Gas,
GasCost: trace.GasCost,
Depth: trace.Depth,
Error: trace.Err,
}
if trace.Stack != nil {
stack := make([]string, len(trace.Stack))
for i, stackValue := range trace.Stack {
stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32))
}
formatted[index].Stack = &stack
2016-06-20 14:47:10 +00:00
}
if trace.Memory != nil {
memory := make([]string, 0, (len(trace.Memory)+31)/32)
for i := 0; i+32 <= len(trace.Memory); i += 32 {
memory = append(memory, fmt.Sprintf("%x", trace.Memory[i:i+32]))
}
formatted[index].Memory = &memory
2016-06-20 14:47:10 +00:00
}
if trace.Storage != nil {
storage := make(map[string]string)
for i, storageValue := range trace.Storage {
storage[fmt.Sprintf("%x", i)] = fmt.Sprintf("%x", storageValue)
}
formatted[index].Storage = &storage
2016-06-20 14:47:10 +00:00
}
}
return formatted
2016-06-20 14:47:10 +00:00
}
// 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
2016-06-20 14:47:10 +00:00
fields := map[string]interface{}{
2017-02-23 00:22:43 +00:00
"number": (*hexutil.Big)(head.Number),
2016-06-20 14:47:10 +00:00
"hash": b.Hash(),
"parentHash": head.ParentHash,
"nonce": head.Nonce,
"mixHash": head.MixDigest,
"sha3Uncles": head.UncleHash,
"logsBloom": head.Bloom,
"stateRoot": head.Root,
"miner": head.Coinbase,
2017-02-23 00:22:43 +00:00
"difficulty": (*hexutil.Big)(head.Difficulty),
"totalDifficulty": (*hexutil.Big)(s.b.GetTd(b.Hash())),
"extraData": hexutil.Bytes(head.Extra),
"size": hexutil.Uint64(b.Size()),
"gasLimit": hexutil.Uint64(head.GasLimit),
"gasUsed": hexutil.Uint64(head.GasUsed),
2017-02-23 00:22:43 +00:00
"timestamp": (*hexutil.Big)(head.Time),
"transactionsRoot": head.TxHash,
"receiptsRoot": head.ReceiptHash,
2016-06-20 14:47:10 +00:00
}
if inclTx {
formatTx := func(tx *types.Transaction) (interface{}, error) {
return tx.Hash(), nil
}
if fullTx {
formatTx = func(tx *types.Transaction) (interface{}, error) {
2017-10-10 09:38:49 +00:00
return newRPCTransactionFromBlockHash(b, tx.Hash()), nil
2016-06-20 14:47:10 +00:00
}
}
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"`
2017-02-23 00:22:43 +00:00
BlockNumber *hexutil.Big `json:"blockNumber"`
2016-06-20 14:47:10 +00:00
From common.Address `json:"from"`
Gas hexutil.Uint64 `json:"gas"`
2017-02-23 00:22:43 +00:00
GasPrice *hexutil.Big `json:"gasPrice"`
2016-06-20 14:47:10 +00:00
Hash common.Hash `json:"hash"`
2017-02-23 00:22:43 +00:00
Input hexutil.Bytes `json:"input"`
Nonce hexutil.Uint64 `json:"nonce"`
2016-06-20 14:47:10 +00:00
To *common.Address `json:"to"`
2017-02-23 00:22:43 +00:00
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"`
2016-06-20 14:47:10 +00:00
}
2017-10-10 09:38:49 +00:00
// newRPCTransaction returns a transaction that will serialize to the RPC
// representation, with the given location metadata set (if available).
func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64) *RPCTransaction {
2016-11-25 05:50:30 +00:00
var signer types.Signer = types.FrontierSigner{}
if tx.Protected() {
signer = types.NewEIP155Signer(tx.ChainId())
}
from, _ := types.Sender(signer, tx)
2017-02-23 00:22:43 +00:00
v, r, s := tx.RawSignatureValues()
2017-10-10 09:38:49 +00:00
result := &RPCTransaction{
2016-06-20 14:47:10 +00:00
From: from,
Gas: hexutil.Uint64(tx.Gas()),
2017-02-23 00:22:43 +00:00
GasPrice: (*hexutil.Big)(tx.GasPrice()),
2016-06-20 14:47:10 +00:00
Hash: tx.Hash(),
2017-02-23 00:22:43 +00:00
Input: hexutil.Bytes(tx.Data()),
Nonce: hexutil.Uint64(tx.Nonce()),
2016-06-20 14:47:10 +00:00
To: tx.To(),
2017-02-23 00:22:43 +00:00
Value: (*hexutil.Big)(tx.Value()),
V: (*hexutil.Big)(v),
R: (*hexutil.Big)(r),
S: (*hexutil.Big)(s),
2016-06-20 14:47:10 +00:00
}
2017-10-10 09:38:49 +00:00
if blockHash != (common.Hash{}) {
result.BlockHash = blockHash
result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber))
result.TransactionIndex = hexutil.Uint(index)
}
return result
2016-06-20 14:47:10 +00:00
}
2017-10-10 09:38:49 +00:00
// newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation
func newRPCPendingTransaction(tx *types.Transaction) *RPCTransaction {
return newRPCTransaction(tx, common.Hash{}, 0, 0)
2016-06-20 14:47:10 +00:00
}
2017-10-10 09:38:49 +00:00
// newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation.
func newRPCTransactionFromBlockIndex(b *types.Block, index uint64) *RPCTransaction {
txs := b.Transactions()
if index >= uint64(len(txs)) {
return nil
}
2017-10-10 09:38:49 +00:00
return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index)
}
2017-10-10 09:38:49 +00:00
// newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index.
func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes {
txs := b.Transactions()
if index >= uint64(len(txs)) {
return nil
}
blob, _ := rlp.EncodeToBytes(txs[index])
return blob
}
2017-10-10 09:38:49 +00:00
// newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction {
2016-06-20 14:47:10 +00:00
for idx, tx := range b.Transactions() {
2017-10-10 09:38:49 +00:00
if tx.Hash() == hash {
return newRPCTransactionFromBlockIndex(b, uint64(idx))
2016-06-20 14:47:10 +00:00
}
}
2017-10-10 09:38:49 +00:00
return nil
2016-06-20 14:47:10 +00:00
}
// PublicTransactionPoolAPI exposes methods for the RPC interface
type PublicTransactionPoolAPI struct {
b Backend
nonceLock *AddrLocker
2016-06-20 14:47:10 +00:00
}
// NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI {
return &PublicTransactionPoolAPI{b, nonceLock}
2016-06-20 14:47:10 +00:00
}
// GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
2017-02-23 00:22:43 +00:00
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
2016-06-20 14:47:10 +00:00
if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
2017-02-23 00:22:43 +00:00
n := hexutil.Uint(len(block.Transactions()))
return &n
2016-06-20 14:47:10 +00:00
}
return nil
}
// GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
2017-02-23 00:22:43 +00:00
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
2016-06-20 14:47:10 +00:00
if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
2017-02-23 00:22:43 +00:00
n := hexutil.Uint(len(block.Transactions()))
return &n
2016-06-20 14:47:10 +00:00
}
return nil
}
// GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
2017-10-10 09:38:49 +00:00
func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
2016-06-20 14:47:10 +00:00
if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
2017-10-10 09:38:49 +00:00
return newRPCTransactionFromBlockIndex(block, uint64(index))
2016-06-20 14:47:10 +00:00
}
2017-10-10 09:38:49 +00:00
return nil
2016-06-20 14:47:10 +00:00
}
// GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
2017-10-10 09:38:49 +00:00
func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
2016-06-20 14:47:10 +00:00
if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
2017-10-10 09:38:49 +00:00
return newRPCTransactionFromBlockIndex(block, uint64(index))
2016-06-20 14:47:10 +00:00
}
2017-10-10 09:38:49 +00:00
return nil
2016-06-20 14:47:10 +00:00
}
// GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
2017-10-10 09:38:49 +00:00
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
2017-10-10 09:38:49 +00:00
return newRPCRawTransactionFromBlockIndex(block, uint64(index))
}
2017-10-10 09:38:49 +00:00
return nil
}
// GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
2017-10-10 09:38:49 +00:00
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
2017-10-10 09:38:49 +00:00
return newRPCRawTransactionFromBlockIndex(block, uint64(index))
}
2017-10-10 09:38:49 +00:00
return nil
}
2016-06-20 14:47:10 +00:00
// GetTransactionCount returns the number of transactions the given address has sent for the given block number
2017-02-23 00:22:43 +00:00
func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) {
state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
2016-06-20 14:47:10 +00:00
if state == nil || err != nil {
return nil, err
}
nonce := state.GetNonce(address)
return (*hexutil.Uint64)(&nonce), state.Error()
2016-06-20 14:47:10 +00:00
}
// GetTransactionByHash returns the transaction for the given hash
2017-10-10 09:38:49 +00:00
func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) *RPCTransaction {
// Try to return an already finalized transaction
if tx, blockHash, blockNumber, index := core.GetTransaction(s.b.ChainDb(), hash); tx != nil {
return newRPCTransaction(tx, blockHash, blockNumber, index)
2016-06-20 14:47:10 +00:00
}
2017-10-10 09:38:49 +00:00
// No finalized transaction, try to retrieve it from the pool
if tx := s.b.GetPoolTransaction(hash); tx != nil {
return newRPCPendingTransaction(tx)
2016-06-20 14:47:10 +00:00
}
2017-10-10 09:38:49 +00:00
// Transaction unknown, return as such
return nil
2016-06-20 14:47:10 +00:00
}
// 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
2017-10-10 09:38:49 +00:00
// Retrieve a finalized transaction, or a pooled otherwise
if tx, _, _, _ = core.GetTransaction(s.b.ChainDb(), hash); tx == nil {
if tx = s.b.GetPoolTransaction(hash); tx == nil {
// Transaction not found anywhere, abort
return nil, nil
}
}
2017-10-10 09:38:49 +00:00
// Serialize to RLP and return
return rlp.EncodeToBytes(tx)
}
2016-06-20 14:47:10 +00:00
// GetTransactionReceipt returns the transaction receipt for the given transaction hash.
func (s *PublicTransactionPoolAPI) GetTransactionReceipt(hash common.Hash) (map[string]interface{}, error) {
2017-10-10 09:38:49 +00:00
tx, blockHash, blockNumber, index := core.GetTransaction(s.b.ChainDb(), hash)
if tx == nil {
return nil, errors.New("unknown transaction")
2016-06-20 14:47:10 +00:00
}
2017-10-10 09:38:49 +00:00
receipt, _, _, _ := core.GetReceipt(s.b.ChainDb(), hash) // Old receipts don't have the lookup data available
if receipt == nil {
return nil, errors.New("unknown receipt")
}
2016-06-20 14:47:10 +00:00
2016-11-25 05:50:30 +00:00
var signer types.Signer = types.FrontierSigner{}
if tx.Protected() {
signer = types.NewEIP155Signer(tx.ChainId())
2016-06-20 14:47:10 +00:00
}
2016-11-25 05:50:30 +00:00
from, _ := types.Sender(signer, tx)
2016-06-20 14:47:10 +00:00
fields := map[string]interface{}{
2017-10-10 09:38:49 +00:00
"blockHash": blockHash,
"blockNumber": hexutil.Uint64(blockNumber),
"transactionHash": hash,
2017-02-23 00:22:43 +00:00
"transactionIndex": hexutil.Uint64(index),
2016-06-20 14:47:10 +00:00
"from": from,
"to": tx.To(),
"gasUsed": hexutil.Uint64(receipt.GasUsed),
"cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed),
2016-06-20 14:47:10 +00:00
"contractAddress": nil,
"logs": receipt.Logs,
"logsBloom": receipt.Bloom,
2016-06-20 14:47:10 +00:00
}
2017-10-17 09:58:04 +00:00
// Assign receipt status or post state.
if len(receipt.PostState) > 0 {
fields["root"] = hexutil.Bytes(receipt.PostState)
} else {
fields["status"] = hexutil.Uint(receipt.Status)
}
2016-06-20 14:47:10 +00:00
if receipt.Logs == nil {
2017-02-23 00:22:43 +00:00
fields["logs"] = [][]*types.Log{}
2016-06-20 14:47:10 +00:00
}
// If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
if receipt.ContractAddress != (common.Address{}) {
2016-06-20 14:47:10 +00:00
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) {
2017-02-27 12:40:42 +00:00
// Look up the wallet containing the requested signer
account := accounts.Account{Address: addr}
2016-11-25 05:50:30 +00:00
2017-02-27 12:40:42 +00:00
wallet, err := s.b.AccountManager().Find(account)
2016-06-20 14:47:10 +00:00
if err != nil {
return nil, err
}
2017-02-27 12:40:42 +00:00
// 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)
2016-06-20 14:47:10 +00:00
}
2016-07-03 19:44:31 +00:00
// SendTxArgs represents the arguments to sumbit a new transaction into the transaction pool.
2016-06-20 14:47:10 +00:00
type SendTxArgs struct {
From common.Address `json:"from"`
To *common.Address `json:"to"`
Gas *hexutil.Uint64 `json:"gas"`
2017-02-23 00:22:43 +00:00
GasPrice *hexutil.Big `json:"gasPrice"`
Value *hexutil.Big `json:"value"`
Nonce *hexutil.Uint64 `json:"nonce"`
// We accept "data" and "input" for backwards-compatibility reasons. "input" is the
// newer name and should be preferred by clients.
Data *hexutil.Bytes `json:"data"`
Input *hexutil.Bytes `json:"input"`
2016-06-20 14:47:10 +00:00
}
// setDefaults is a helper function that fills in default values for unspecified tx fields.
2017-02-23 00:22:43 +00:00
func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
2016-06-20 14:47:10 +00:00
if args.Gas == nil {
args.Gas = new(hexutil.Uint64)
*(*uint64)(args.Gas) = 90000
2016-06-20 14:47:10 +00:00
}
if args.GasPrice == nil {
2016-07-03 19:44:31 +00:00
price, err := b.SuggestPrice(ctx)
2016-06-20 14:47:10 +00:00
if err != nil {
2017-02-23 00:22:43 +00:00
return err
2016-06-20 14:47:10 +00:00
}
2017-02-23 00:22:43 +00:00
args.GasPrice = (*hexutil.Big)(price)
2016-06-20 14:47:10 +00:00
}
if args.Value == nil {
2017-02-23 00:22:43 +00:00
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)
}
if args.Data != nil && args.Input != nil && !bytes.Equal(*args.Data, *args.Input) {
return errors.New(`Both "data" and "input" are set and not equal. Please use "input" to pass transaction call data.`)
}
2017-02-23 00:22:43 +00:00
return nil
}
func (args *SendTxArgs) toTransaction() *types.Transaction {
var input []byte
if args.Data != nil {
input = *args.Data
} else if args.Input != nil {
input = *args.Input
}
2017-02-23 00:22:43 +00:00
if args.To == nil {
return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
2016-06-20 14:47:10 +00:00
}
return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
2016-07-03 19:44:31 +00:00
}
2017-02-23 00:22:43 +00:00
// submitTransaction is a helper function that submits tx to txPool and logs a message.
2017-02-27 12:40:42 +00:00
func submitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) {
if err := b.SendTx(ctx, tx); err != nil {
2016-07-03 19:44:31 +00:00
return common.Hash{}, err
}
2017-02-27 12:40:42 +00:00
if tx.To() == nil {
signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
2017-10-17 09:58:04 +00:00
from, err := types.Sender(signer, tx)
if err != nil {
return common.Hash{}, err
}
2017-02-27 12:40:42 +00:00
addr := crypto.CreateAddress(from, tx.Nonce())
log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
2016-07-03 19:44:31 +00:00
} else {
log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
2016-07-03 19:44:31 +00:00
}
2017-02-27 12:40:42 +00:00
return tx.Hash(), nil
2016-07-03 19:44:31 +00:00
}
// 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) {
// 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
}
if args.Nonce == nil {
// Hold the addresse's mutex around signing to prevent concurrent assignment of
// the same nonce to multiple accounts.
s.nonceLock.LockAddr(args.From)
defer s.nonceLock.UnlockAddr(args.From)
}
// Set some sanity defaults and terminate on failure
if err := args.setDefaults(ctx, s.b); 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)
}
2016-06-20 14:47:10 +00:00
// SendRawTransaction will add the signed transaction to the transaction pool.
// The sender is responsible for signing the transaction and using the correct nonce.
2017-10-17 09:58:04 +00:00
func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) {
2016-06-20 14:47:10 +00:00
tx := new(types.Transaction)
2017-02-23 00:22:43 +00:00
if err := rlp.DecodeBytes(encodedTx, tx); err != nil {
2017-10-17 09:58:04 +00:00
return common.Hash{}, err
2016-06-20 14:47:10 +00:00
}
2017-10-17 09:58:04 +00:00
return submitTransaction(ctx, s.b, tx)
2016-06-20 14:47:10 +00:00
}
2016-11-25 05:50:30 +00:00
// Sign calculates an ECDSA signature for:
// keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
//
2017-02-23 00:22:43 +00:00
// 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.
//
2016-11-25 05:50:30 +00:00
// The account associated with addr must be unlocked.
//
// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
2017-02-23 00:22:43 +00:00
func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
2017-02-27 12:40:42 +00:00
// 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))
2017-02-23 00:22:43 +00:00
if err == nil {
signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
2016-06-20 14:47:10 +00:00
}
2017-02-23 00:22:43 +00:00
return signature, err
2016-06-20 14:47:10 +00:00
}
2016-07-03 19:44:31 +00:00
// SignTransactionResult represents a RLP encoded signed transaction.
2016-06-20 14:47:10 +00:00
type SignTransactionResult struct {
2017-02-23 00:22:43 +00:00
Raw hexutil.Bytes `json:"raw"`
Tx *types.Transaction `json:"tx"`
2016-06-20 14:47:10 +00:00
}
// 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.
2017-02-23 00:22:43 +00:00
func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
if args.Gas == nil {
return nil, fmt.Errorf("gas not specified")
}
if args.GasPrice == nil {
return nil, fmt.Errorf("gasPrice not specified")
}
if args.Nonce == nil {
return nil, fmt.Errorf("nonce not specified")
}
2017-02-23 00:22:43 +00:00
if err := args.setDefaults(ctx, s.b); err != nil {
return nil, err
2016-06-20 14:47:10 +00:00
}
2017-02-23 00:22:43 +00:00
tx, err := s.sign(args.From, args.toTransaction())
2016-06-20 14:47:10 +00:00
if err != nil {
return nil, err
}
2017-02-23 00:22:43 +00:00
data, err := rlp.EncodeToBytes(tx)
2016-06-20 14:47:10 +00:00
if err != nil {
return nil, err
}
2017-02-23 00:22:43 +00:00
return &SignTransactionResult{data, tx}, nil
2016-06-20 14:47:10 +00:00
}
// PendingTransactions returns the transactions that are in the transaction pool and have a from address that is one of
// the accounts this node manages.
2017-02-23 00:22:43 +00:00
func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
pending, err := s.b.GetPoolTransactions()
if err != nil {
return nil, err
}
2016-07-03 19:44:31 +00:00
transactions := make([]*RPCTransaction, 0, len(pending))
2016-06-20 14:47:10 +00:00
for _, tx := range pending {
2016-11-25 05:50:30 +00:00
var signer types.Signer = types.HomesteadSigner{}
if tx.Protected() {
signer = types.NewEIP155Signer(tx.ChainId())
}
from, _ := types.Sender(signer, tx)
2017-02-27 12:40:42 +00:00
if _, err := s.b.AccountManager().Find(accounts.Account{Address: from}); err == nil {
2016-06-20 14:47:10 +00:00
transactions = append(transactions, newRPCPendingTransaction(tx))
}
}
2017-02-23 00:22:43 +00:00
return transactions, nil
2016-06-20 14:47:10 +00:00
}
2017-02-23 00:22:43 +00:00
// 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 *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {
2017-02-23 00:22:43 +00:00
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
}
2016-06-20 14:47:10 +00:00
for _, p := range pending {
2016-11-25 05:50:30 +00:00
var signer types.Signer = types.HomesteadSigner{}
if p.Protected() {
signer = types.NewEIP155Signer(p.ChainId())
}
2017-02-23 00:22:43 +00:00
wantSigHash := signer.Hash(matchTx)
2016-11-25 05:50:30 +00:00
2017-02-23 00:22:43 +00:00
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
2016-06-20 14:47:10 +00:00
}
2017-02-23 00:22:43 +00:00
if gasLimit != nil {
sendArgs.Gas = gasLimit
2016-06-20 14:47:10 +00:00
}
2017-02-23 00:22:43 +00:00
signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())
2016-06-20 14:47:10 +00:00
if err != nil {
return common.Hash{}, err
}
if err = s.b.SendTx(ctx, signedTx); err != nil {
return common.Hash{}, err
}
return signedTx.Hash(), nil
}
}
2017-02-23 00:22:43 +00:00
return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash())
2016-06-20 14:47:10 +00:00
}
2017-10-17 09:58:04 +00:00
// PublicDebugAPI is the collection of Ethereum APIs exposed over the public
2016-06-20 14:47:10 +00:00
// 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)
}
2017-10-10 09:38:49 +00:00
return block.String(), nil
2016-06-20 14:47:10 +00:00
}
// 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
2016-06-20 14:47:10 +00:00
}
2017-10-17 09:58:04 +00:00
// PrivateDebugAPI is the collection of Ethereum APIs exposed over the private
2016-06-20 14:47:10 +00:00
// 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)
}
2016-11-25 05:50:30 +00:00
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))
2016-11-25 05:50:30 +00:00
err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}})
if err != nil {
log.Error("Database compaction failed", "err", err)
2016-11-25 05:50:30 +00:00
return err
}
}
return nil
}
2016-06-20 14:47:10 +00:00
// SetHead rewinds the head of the blockchain to a previous block.
2017-02-23 00:22:43 +00:00
func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
api.b.SetHead(uint64(number))
2016-06-20 14:47:10 +00:00
}
// PublicNetAPI offers network related RPC methods
type PublicNetAPI struct {
net *p2p.Server
networkVersion uint64
2016-06-20 14:47:10 +00:00
}
// NewPublicNetAPI creates a new net API instance.
func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
2016-06-20 14:47:10 +00:00
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
}
2016-07-03 19:44:31 +00:00
// PeerCount returns the number of connected peers
2017-02-23 00:22:43 +00:00
func (s *PublicNetAPI) PeerCount() hexutil.Uint {
return hexutil.Uint(s.net.PeerCount())
2016-06-20 14:47:10 +00:00
}
2016-07-03 19:44:31 +00:00
// Version returns the current ethereum protocol version.
2016-06-20 14:47:10 +00:00
func (s *PublicNetAPI) Version() string {
return fmt.Sprintf("%d", s.networkVersion)
}