api.go 49.9 KB
Newer Older
1
// Copyright 2015 The go-ethereum Authors
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// 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 (
20
	"context"
21
	"errors"
22 23 24 25 26 27
	"fmt"
	"math/big"
	"strings"
	"time"

	"github.com/ethereum/go-ethereum/accounts"
28
	"github.com/ethereum/go-ethereum/accounts/keystore"
29
	"github.com/ethereum/go-ethereum/common"
30
	"github.com/ethereum/go-ethereum/common/hexutil"
31
	"github.com/ethereum/go-ethereum/common/math"
32
	"github.com/ethereum/go-ethereum/consensus/ethash"
33 34 35 36
	"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"
37
	"github.com/ethereum/go-ethereum/log"
38
	"github.com/ethereum/go-ethereum/p2p"
39
	"github.com/ethereum/go-ethereum/params"
40 41 42
	"github.com/ethereum/go-ethereum/rlp"
	"github.com/ethereum/go-ethereum/rpc"
	"github.com/syndtr/goleveldb/leveldb"
43
	"github.com/syndtr/goleveldb/leveldb/util"
44 45
)

46
const (
47 48
	defaultGas      = 90000
	defaultGasPrice = 50 * params.Shannon
49
)
50

51 52 53
// 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 {
54
	b Backend
55 56
}

57
// NewPublicEthereumAPI creates a new Ethereum protocol API.
58 59
func NewPublicEthereumAPI(b Backend) *PublicEthereumAPI {
	return &PublicEthereumAPI{b}
60 61 62 63 64 65 66 67
}

// 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
68 69
func (s *PublicEthereumAPI) ProtocolVersion() hexutil.Uint {
	return hexutil.Uint(s.b.ProtocolVersion())
70 71 72 73 74 75 76 77 78 79
}

// 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) {
80
	progress := s.b.Downloader().Progress()
81 82

	// Return not syncing if the synchronisation already completed
83
	if progress.CurrentBlock >= progress.HighestBlock {
84 85 86 87
		return false, nil
	}
	// Otherwise gather the block sync stats
	return map[string]interface{}{
88 89 90 91 92
		"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),
93 94 95 96 97 98 99 100 101 102 103 104 105 106
	}, 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.
107 108 109 110
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),
111 112 113 114
	}
	pending, queue := s.b.TxPoolContent()

	// Flatten the pending transactions
115 116
	for account, txs := range pending {
		dump := make(map[string]*RPCTransaction)
117 118
		for _, tx := range txs {
			dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx)
119 120 121 122
		}
		content["pending"][account.Hex()] = dump
	}
	// Flatten the queued transactions
123 124
	for account, txs := range queue {
		dump := make(map[string]*RPCTransaction)
125 126
		for _, tx := range txs {
			dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx)
127 128 129 130 131 132 133
		}
		content["queued"][account.Hex()] = dump
	}
	return content
}

// Status returns the number of pending and queued transaction in the pool.
134
func (s *PublicTxPoolAPI) Status() map[string]hexutil.Uint {
135
	pending, queue := s.b.Stats()
136 137 138
	return map[string]hexutil.Uint{
		"pending": hexutil.Uint(pending),
		"queued":  hexutil.Uint(queue),
139 140 141 142 143
	}
}

// Inspect retrieves the content of the transaction pool and flattens it into an
// easily inspectable list.
144 145 146 147
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),
148 149 150 151 152 153
	}
	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 {
154
			return fmt.Sprintf("%s: %v wei + %v gas × %v wei", tx.To().Hex(), tx.Value(), tx.Gas(), tx.GasPrice())
155
		}
156
		return fmt.Sprintf("contract creation: %v wei + %v gas × %v wei", tx.Value(), tx.Gas(), tx.GasPrice())
157 158
	}
	// Flatten the pending transactions
159 160
	for account, txs := range pending {
		dump := make(map[string]string)
161 162
		for _, tx := range txs {
			dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx)
163 164 165 166
		}
		content["pending"][account.Hex()] = dump
	}
	// Flatten the queued transactions
167 168
	for account, txs := range queue {
		dump := make(map[string]string)
169 170
		for _, tx := range txs {
			dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx)
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
		}
		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
189
func (s *PublicAccountAPI) Accounts() []common.Address {
190
	addresses := make([]common.Address, 0) // return [] instead of nil if empty
191 192 193 194 195 196
	for _, wallet := range s.am.Wallets() {
		for _, account := range wallet.Accounts() {
			addresses = append(addresses, account.Address)
		}
	}
	return addresses
197 198 199 200 201 202
}

// 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 {
203 204 205
	am        *accounts.Manager
	nonceLock *AddrLocker
	b         Backend
206 207 208
}

// NewPrivateAccountAPI create a new PrivateAccountAPI.
209
func NewPrivateAccountAPI(b Backend, nonceLock *AddrLocker) *PrivateAccountAPI {
210
	return &PrivateAccountAPI{
211 212 213
		am:        b.AccountManager(),
		nonceLock: nonceLock,
		b:         b,
214 215 216 217 218
	}
}

// ListAccounts will return a list of addresses for accounts this node manages.
func (s *PrivateAccountAPI) ListAccounts() []common.Address {
219
	addresses := make([]common.Address, 0) // return [] instead of nil if empty
220 221 222 223
	for _, wallet := range s.am.Wallets() {
		for _, account := range wallet.Accounts() {
			addresses = append(addresses, account.Address)
		}
224 225 226 227
	}
	return addresses
}

228 229 230 231 232
// 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"`
233 234
	Failure  string             `json:"failure,omitempty"`
	Accounts []accounts.Account `json:"accounts,omitempty"`
235 236 237 238
}

// ListWallets will return a list of wallets this node manages.
func (s *PrivateAccountAPI) ListWallets() []rawWallet {
239
	wallets := make([]rawWallet, 0) // return [] instead of nil if empty
240
	for _, wallet := range s.am.Wallets() {
241 242 243
		status, failure := wallet.Status()

		raw := rawWallet{
244
			URL:      wallet.URL().String(),
245
			Status:   status,
246
			Accounts: wallet.Accounts(),
247 248 249 250 251
		}
		if failure != nil {
			raw.Failure = failure.Error()
		}
		wallets = append(wallets, raw)
252 253 254 255
	}
	return wallets
}

256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
// 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)
}

272 273 274 275 276 277 278
// 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
	}
279 280 281 282
	derivPath, err := accounts.ParseDerivationPath(path)
	if err != nil {
		return accounts.Account{}, err
	}
283 284 285
	if pin == nil {
		pin = new(bool)
	}
286
	return wallet.Derive(derivPath, *pin)
287 288
}

289 290
// NewAccount will create a new account and returns the address for the new account.
func (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) {
291
	acc, err := fetchKeystore(s.am).NewAccount(password)
292 293 294 295 296 297
	if err == nil {
		return acc.Address, nil
	}
	return common.Address{}, err
}

298 299
// fetchKeystore retrives the encrypted keystore from the account manager.
func fetchKeystore(am *accounts.Manager) *keystore.KeyStore {
300
	return am.Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
301 302
}

303 304 305
// 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) {
306
	key, err := crypto.HexToECDSA(privkey)
307 308 309
	if err != nil {
		return common.Address{}, err
	}
310
	acc, err := fetchKeystore(s.am).ImportECDSA(key, password)
311 312 313 314 315 316
	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.
317 318
func (s *PrivateAccountAPI) UnlockAccount(addr common.Address, password string, duration *uint64) (bool, error) {
	const max = uint64(time.Duration(math.MaxInt64) / time.Second)
319
	var d time.Duration
320
	if duration == nil {
321
		d = 300 * time.Second
322 323
	} else if *duration > max {
		return false, errors.New("unlock duration too large")
324 325
	} else {
		d = time.Duration(*duration) * time.Second
326
	}
327
	err := fetchKeystore(s.am).TimedUnlock(accounts.Account{Address: addr}, password, d)
328
	return err == nil, err
329 330 331 332
}

// LockAccount will lock the account associated with the given address when it's unlocked.
func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool {
333
	return fetchKeystore(s.am).Lock(addr) == nil
334 335
}

336
// SendTransaction will create a transaction from the given arguments and
337 338
// tries to sign it with the key associated with args.To. If the given passwd isn't
// able to decrypt the key it fails.
339
func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
340 341 342 343 344 345 346
	// 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
	}
347 348 349 350 351 352 353 354 355 356 357 358

	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
	}
359
	// Assemble the transaction and sign with the wallet
360
	tx := args.toTransaction()
361 362 363 364 365

	var chainID *big.Int
	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
		chainID = config.ChainId
	}
366
	signed, err := wallet.SignTxWithPassphrase(account, passwd, tx, chainID)
367 368 369
	if err != nil {
		return common.Hash{}, err
	}
370
	return submitTransaction(ctx, s.b, signed)
371 372
}

373
// signHash is a helper function that calculates a hash for the given message that can be
374 375 376 377 378 379 380
// 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 {
381 382 383 384 385 386 387
	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))
//
388 389 390
// 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.
//
391 392 393
// The key used to calculate the signature is decrypted with the given password.
//
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign
394
func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {
395 396 397 398 399 400 401 402 403
	// 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))
404 405 406
	if err != nil {
		return nil, err
	}
407
	signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
408
	return signature, nil
409 410 411 412 413 414 415 416
}

// 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)
//
417 418 419
// 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.
//
420
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover
421
func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {
422 423 424
	if len(sig) != 65 {
		return common.Address{}, fmt.Errorf("signature must be 65 bytes long")
	}
425 426
	if sig[64] != 27 && sig[64] != 28 {
		return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)")
427
	}
428
	sig[64] -= 27 // Transform yellow paper V from 27/28 to 0/1
429

430
	rpk, err := crypto.Ecrecover(signHash(data), sig)
431 432 433 434 435 436 437 438
	if err != nil {
		return common.Address{}, err
	}
	pubKey := crypto.ToECDSAPub(rpk)
	recoveredAddr := crypto.PubkeyToAddress(*pubKey)
	return recoveredAddr, nil
}

439 440 441 442 443 444
// 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)
}

445 446 447
// 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 {
448
	b Backend
449 450
}

451
// NewPublicBlockChainAPI creates a new Ethereum blockchain API.
452
func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI {
453
	return &PublicBlockChainAPI{b}
454 455 456 457
}

// BlockNumber returns the block number of the chain head.
func (s *PublicBlockChainAPI) BlockNumber() *big.Int {
458 459
	header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available
	return header.Number
460 461 462 463 464 465
}

// 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) {
466
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
467 468 469
	if state == nil || err != nil {
		return nil, err
	}
470 471
	b := state.GetBalance(address)
	return b, state.Error()
472 473 474 475 476 477 478 479 480 481
}

// 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
482
			for _, field := range []string{"hash", "nonce", "miner"} {
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
				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.
503
func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {
504 505 506
	block, err := s.b.BlockByNumber(ctx, blockNr)
	if block != nil {
		uncles := block.Uncles()
507
		if index >= hexutil.Uint(len(uncles)) {
508
			log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index)
509 510
			return nil, nil
		}
511
		block = types.NewBlockWithHeader(uncles[index])
512 513 514 515 516 517 518
		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.
519
func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {
520 521 522
	block, err := s.b.GetBlock(ctx, blockHash)
	if block != nil {
		uncles := block.Uncles()
523
		if index >= hexutil.Uint(len(uncles)) {
524
			log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index)
525 526
			return nil, nil
		}
527
		block = types.NewBlockWithHeader(uncles[index])
528 529 530 531 532 533
		return s.rpcOutputBlock(block, false, false)
	}
	return nil, err
}

// GetUncleCountByBlockNumber returns number of uncles in the block for the given block number
534
func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
535
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
536 537
		n := hexutil.Uint(len(block.Uncles()))
		return &n
538 539 540 541 542
	}
	return nil
}

// GetUncleCountByBlockHash returns number of uncles in the block for the given block hash
543
func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
544
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
545 546
		n := hexutil.Uint(len(block.Uncles()))
		return &n
547 548 549 550 551
	}
	return nil
}

// GetCode returns the code stored at the given address in the state for the given block number.
552
func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
553
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
554
	if state == nil || err != nil {
555
		return nil, err
556
	}
557 558
	code := state.GetCode(address)
	return code, state.Error()
559 560 561 562 563
}

// 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.
564
func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
565
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
566
	if state == nil || err != nil {
567
		return nil, err
568
	}
569 570
	res := state.GetState(address, common.HexToHash(key))
	return res[:], state.Error()
571 572 573 574 575 576
}

// CallArgs represents the arguments for a call.
type CallArgs struct {
	From     common.Address  `json:"from"`
	To       *common.Address `json:"to"`
577 578 579
	Gas      hexutil.Big     `json:"gas"`
	GasPrice hexutil.Big     `json:"gasPrice"`
	Value    hexutil.Big     `json:"value"`
580
	Data     hexutil.Bytes   `json:"data"`
581 582
}

583
func (s *PublicBlockChainAPI) doCall(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber, vmCfg vm.Config) ([]byte, *big.Int, bool, error) {
584
	defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now())
585

586
	state, header, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
587
	if state == nil || err != nil {
588
		return nil, common.Big0, false, err
589
	}
590 591 592
	// Set sender address or use a default if none specified
	addr := args.From
	if addr == (common.Address{}) {
593 594 595 596
		if wallets := s.b.AccountManager().Wallets(); len(wallets) > 0 {
			if accounts := wallets[0].Accounts(); len(accounts) > 0 {
				addr = accounts[0].Address
			}
597 598
		}
	}
599
	// Set default gas & gas price if none were set
600
	gas, gasPrice := args.Gas.ToInt(), args.GasPrice.ToInt()
601
	if gas.Sign() == 0 {
602
		gas = big.NewInt(50000000)
603
	}
604
	if gasPrice.Sign() == 0 {
605
		gasPrice = new(big.Int).SetUint64(defaultGasPrice)
606
	}
607 608

	// Create new call message
609
	msg := types.NewMessage(addr, args.To, 0, args.Value.ToInt(), gas, gasPrice, args.Data, false)
610

611 612 613 614 615 616 617
	// 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)
618
	}
619 620 621 622 623 624 625
	// 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 {
626
		return nil, common.Big0, false, err
627 628 629 630
	}
	// Wait for the context to be done and cancel the evm. Even if the
	// EVM has finished, cancelling may be done (repeatedly)
	go func() {
631 632
		<-ctx.Done()
		evm.Cancel()
633 634 635 636
	}()

	// Setup the gas pool (also for unmetered requests)
	// and apply the message.
637
	gp := new(core.GasPool).AddGas(math.MaxBig256)
638
	res, gas, failed, err := core.ApplyMessage(evm, msg, gp)
639
	if err := vmError(); err != nil {
640
		return nil, common.Big0, false, err
641
	}
642
	return res, gas, failed, err
643 644 645
}

// Call executes the given transaction on the state for the given block number.
646
// It doesn't make and changes in the state/blockchain and is useful to execute and retrieve values.
647
func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
648
	result, _, _, err := s.doCall(ctx, args, blockNr, vm.Config{DisableGasMetering: true})
649
	return (hexutil.Bytes)(result), err
650 651
}

652 653
// EstimateGas returns an estimate of the amount of gas needed to execute the
// given transaction against the current pending block.
654
func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (*hexutil.Big, error) {
655
	// Determine the lowest and highest possible gas limits to binary search in between
656
	var (
657 658 659
		lo  uint64 = params.TxGas - 1
		hi  uint64
		cap uint64
660 661
	)
	if (*big.Int)(&args.Gas).Uint64() >= params.TxGas {
662 663 664 665 666 667 668 669 670
		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()
	}
671
	cap = hi
672

673 674 675
	// Create a helper to check if a gas allowance results in an executable transaction
	executable := func(gas uint64) bool {
		(*big.Int)(&args.Gas).SetUint64(gas)
676 677
		_, _, failed, err := s.doCall(ctx, args, rpc.PendingBlockNumber, vm.Config{})
		if err != nil || failed {
678 679 680 681 682 683 684 685
			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) {
686
			lo = mid
687 688 689 690 691 692 693 694
		} else {
			hi = mid
		}
	}
	// Reject the transaction as invalid if it still fails at the highest allowance
	if hi == cap {
		if !executable(hi) {
			return nil, fmt.Errorf("gas required exceeds allowance or always failing transaction")
695 696 697
		}
	}
	return (*hexutil.Big)(new(big.Int).SetUint64(hi)), nil
698 699 700
}

// ExecutionResult groups all structured logs emitted by the EVM
701 702
// while replaying a transaction in debug mode as well as transaction
// execution status, the amount of gas used and the return value
703 704
type ExecutionResult struct {
	Gas         *big.Int       `json:"gas"`
705
	Failed      bool           `json:"failed"`
706 707 708 709 710 711 712
	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 {
713 714 715 716 717 718 719 720 721
	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"`
722 723 724
}

// formatLogs formats EVM returned structured logs for json output
725 726 727 728
func FormatLogs(logs []vm.StructLog) []StructLogRes {
	formatted := make([]StructLogRes, len(logs))
	for index, trace := range logs {
		formatted[index] = StructLogRes{
729 730 731 732 733 734 735
			Pc:      trace.Pc,
			Op:      trace.Op.String(),
			Gas:     trace.Gas,
			GasCost: trace.GasCost,
			Depth:   trace.Depth,
			Error:   trace.Err,
		}
736 737 738 739 740 741
		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
742
		}
743 744 745 746 747 748
		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
749
		}
750 751 752 753 754 755
		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
756 757
		}
	}
758
	return formatted
759 760 761 762 763 764
}

// 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) {
765
	head := b.Header() // copies the header once
766
	fields := map[string]interface{}{
767
		"number":           (*hexutil.Big)(head.Number),
768
		"hash":             b.Hash(),
769 770 771 772 773 774 775
		"parentHash":       head.ParentHash,
		"nonce":            head.Nonce,
		"mixHash":          head.MixDigest,
		"sha3Uncles":       head.UncleHash,
		"logsBloom":        head.Bloom,
		"stateRoot":        head.Root,
		"miner":            head.Coinbase,
776 777
		"difficulty":       (*hexutil.Big)(head.Difficulty),
		"totalDifficulty":  (*hexutil.Big)(s.b.GetTd(b.Hash())),
778
		"extraData":        hexutil.Bytes(head.Extra),
779 780 781 782
		"size":             hexutil.Uint64(uint64(b.Size().Int64())),
		"gasLimit":         (*hexutil.Big)(head.GasLimit),
		"gasUsed":          (*hexutil.Big)(head.GasUsed),
		"timestamp":        (*hexutil.Big)(head.Time),
783
		"transactionsRoot": head.TxHash,
784
		"receiptsRoot":     head.ReceiptHash,
785 786 787 788 789 790 791 792 793
	}

	if inclTx {
		formatTx := func(tx *types.Transaction) (interface{}, error) {
			return tx.Hash(), nil
		}

		if fullTx {
			formatTx = func(tx *types.Transaction) (interface{}, error) {
794
				return newRPCTransactionFromBlockHash(b, tx.Hash()), nil
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
			}
		}

		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"`
822
	BlockNumber      *hexutil.Big    `json:"blockNumber"`
823
	From             common.Address  `json:"from"`
824 825
	Gas              *hexutil.Big    `json:"gas"`
	GasPrice         *hexutil.Big    `json:"gasPrice"`
826
	Hash             common.Hash     `json:"hash"`
827
	Input            hexutil.Bytes   `json:"input"`
828
	Nonce            hexutil.Uint64  `json:"nonce"`
829
	To               *common.Address `json:"to"`
830 831 832 833 834
	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"`
835 836
}

837 838 839
// 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 {
840 841 842 843 844
	var signer types.Signer = types.FrontierSigner{}
	if tx.Protected() {
		signer = types.NewEIP155Signer(tx.ChainId())
	}
	from, _ := types.Sender(signer, tx)
845
	v, r, s := tx.RawSignatureValues()
846 847

	result := &RPCTransaction{
848
		From:     from,
849 850
		Gas:      (*hexutil.Big)(tx.Gas()),
		GasPrice: (*hexutil.Big)(tx.GasPrice()),
851
		Hash:     tx.Hash(),
852
		Input:    hexutil.Bytes(tx.Data()),
853
		Nonce:    hexutil.Uint64(tx.Nonce()),
854
		To:       tx.To(),
855 856 857 858
		Value:    (*hexutil.Big)(tx.Value()),
		V:        (*hexutil.Big)(v),
		R:        (*hexutil.Big)(r),
		S:        (*hexutil.Big)(s),
859
	}
860 861 862 863 864 865
	if blockHash != (common.Hash{}) {
		result.BlockHash = blockHash
		result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber))
		result.TransactionIndex = hexutil.Uint(index)
	}
	return result
866 867
}

868 869 870
// 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)
871 872
}

873 874 875 876 877
// 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
878
	}
879 880
	return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index)
}
881

882 883 884 885 886 887 888 889
// 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
890 891
}

892 893
// newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction {
894
	for idx, tx := range b.Transactions() {
895 896
		if tx.Hash() == hash {
			return newRPCTransactionFromBlockIndex(b, uint64(idx))
897 898
		}
	}
899
	return nil
900 901 902 903
}

// PublicTransactionPoolAPI exposes methods for the RPC interface
type PublicTransactionPoolAPI struct {
904 905
	b         Backend
	nonceLock *AddrLocker
906 907 908
}

// NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
909 910
func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI {
	return &PublicTransactionPoolAPI{b, nonceLock}
911 912 913
}

// GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
914
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
915
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
916 917
		n := hexutil.Uint(len(block.Transactions()))
		return &n
918 919 920 921 922
	}
	return nil
}

// GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
923
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
924
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
925 926
		n := hexutil.Uint(len(block.Transactions()))
		return &n
927 928 929 930 931
	}
	return nil
}

// GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
932
func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
933
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
934
		return newRPCTransactionFromBlockIndex(block, uint64(index))
935
	}
936
	return nil
937 938 939
}

// GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
940
func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
941
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
942
		return newRPCTransactionFromBlockIndex(block, uint64(index))
943
	}
944
	return nil
945 946
}

947
// GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
948
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
949
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
950
		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
951
	}
952
	return nil
953 954 955
}

// GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
956
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
957
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
958
		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
959
	}
960
	return nil
961 962
}

963
// GetTransactionCount returns the number of transactions the given address has sent for the given block number
964
func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) {
965
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
966 967 968
	if state == nil || err != nil {
		return nil, err
	}
969 970
	nonce := state.GetNonce(address)
	return (*hexutil.Uint64)(&nonce), state.Error()
971 972 973
}

// GetTransactionByHash returns the transaction for the given hash
974 975 976 977
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)
978
	}
979 980 981
	// No finalized transaction, try to retrieve it from the pool
	if tx := s.b.GetPoolTransaction(hash); tx != nil {
		return newRPCPendingTransaction(tx)
982
	}
983 984
	// Transaction unknown, return as such
	return nil
985 986
}

987
// GetRawTransactionByHash returns the bytes of the transaction for the given hash.
988
func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
989 990
	var tx *types.Transaction

991 992 993 994 995 996
	// 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
		}
997
	}
998
	// Serialize to RLP and return
999 1000 1001
	return rlp.EncodeToBytes(tx)
}

1002
// GetTransactionReceipt returns the transaction receipt for the given transaction hash.
1003
func (s *PublicTransactionPoolAPI) GetTransactionReceipt(hash common.Hash) (map[string]interface{}, error) {
1004 1005
	tx, blockHash, blockNumber, index := core.GetTransaction(s.b.ChainDb(), hash)
	if tx == nil {
1006 1007
		return nil, nil
	}
1008
	receipt, _, _, _ := core.GetReceipt(s.b.ChainDb(), hash) // Old receipts don't have the lookup data available
1009

1010 1011 1012
	var signer types.Signer = types.FrontierSigner{}
	if tx.Protected() {
		signer = types.NewEIP155Signer(tx.ChainId())
1013
	}
1014
	from, _ := types.Sender(signer, tx)
1015 1016

	fields := map[string]interface{}{
1017 1018
		"blockHash":         blockHash,
		"blockNumber":       hexutil.Uint64(blockNumber),
1019
		"transactionHash":   hash,
1020
		"transactionIndex":  hexutil.Uint64(index),
1021 1022
		"from":              from,
		"to":                tx.To(),
1023 1024
		"gasUsed":           (*hexutil.Big)(receipt.GasUsed),
		"cumulativeGasUsed": (*hexutil.Big)(receipt.CumulativeGasUsed),
1025 1026
		"contractAddress":   nil,
		"logs":              receipt.Logs,
1027
		"logsBloom":         receipt.Bloom,
1028
	}
1029 1030 1031 1032 1033

	// Assign receipt status or post state.
	if len(receipt.PostState) > 0 {
		fields["root"] = hexutil.Bytes(receipt.PostState)
	} else {
1034
		fields["status"] = hexutil.Uint(receipt.Status)
1035
	}
1036
	if receipt.Logs == nil {
1037
		fields["logs"] = [][]*types.Log{}
1038 1039
	}
	// If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
1040
	if receipt.ContractAddress != (common.Address{}) {
1041 1042 1043 1044 1045 1046 1047
		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) {
1048 1049 1050 1051 1052 1053 1054 1055
	// 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
1056 1057 1058
	var chainID *big.Int
	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
		chainID = config.ChainId
1059
	}
1060
	return wallet.SignTx(account, tx, chainID)
1061 1062 1063 1064 1065 1066
}

// 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"`
1067 1068 1069 1070 1071
	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"`
1072 1073 1074
}

// prepareSendTxArgs is a helper function that fills in default values for unspecified tx fields.
1075
func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
1076
	if args.Gas == nil {
1077
		args.Gas = (*hexutil.Big)(big.NewInt(defaultGas))
1078 1079 1080 1081
	}
	if args.GasPrice == nil {
		price, err := b.SuggestPrice(ctx)
		if err != nil {
1082
			return err
1083
		}
1084
		args.GasPrice = (*hexutil.Big)(price)
1085 1086
	}
	if args.Value == nil {
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
		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)
1102
	}
1103
	return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), (*big.Int)(args.Gas), (*big.Int)(args.GasPrice), args.Data)
1104 1105
}

1106
// submitTransaction is a helper function that submits tx to txPool and logs a message.
1107 1108
func submitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) {
	if err := b.SendTx(ctx, tx); err != nil {
1109 1110
		return common.Hash{}, err
	}
1111 1112
	if tx.To() == nil {
		signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
1113 1114 1115 1116
		from, err := types.Sender(signer, tx)
		if err != nil {
			return common.Hash{}, err
		}
1117
		addr := crypto.CreateAddress(from, tx.Nonce())
1118
		log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
1119
	} else {
1120
		log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
1121
	}
1122
	return tx.Hash(), nil
1123 1124 1125 1126 1127
}

// 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) {
1128

1129 1130 1131 1132 1133 1134 1135
	// 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
	}
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147

	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
	}
1148
	// Assemble the transaction and sign with the wallet
1149
	tx := args.toTransaction()
1150 1151 1152 1153 1154

	var chainID *big.Int
	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
		chainID = config.ChainId
	}
1155
	signed, err := wallet.SignTx(account, tx, chainID)
1156 1157 1158
	if err != nil {
		return common.Hash{}, err
	}
1159
	return submitTransaction(ctx, s.b, signed)
1160 1161 1162 1163
}

// SendRawTransaction will add the signed transaction to the transaction pool.
// The sender is responsible for signing the transaction and using the correct nonce.
1164
func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) {
1165
	tx := new(types.Transaction)
1166
	if err := rlp.DecodeBytes(encodedTx, tx); err != nil {
1167
		return common.Hash{}, err
1168
	}
1169
	return submitTransaction(ctx, s.b, tx)
1170 1171
}

1172 1173 1174
// Sign calculates an ECDSA signature for:
// keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
//
1175 1176 1177
// 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.
//
1178 1179 1180
// The account associated with addr must be unlocked.
//
// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
1181
func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
1182 1183 1184 1185 1186 1187 1188 1189 1190
	// 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))
1191
	if err == nil {
1192
		signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
1193 1194
	}
	return signature, err
1195 1196 1197 1198
}

// SignTransactionResult represents a RLP encoded signed transaction.
type SignTransactionResult struct {
1199 1200
	Raw hexutil.Bytes      `json:"raw"`
	Tx  *types.Transaction `json:"tx"`
1201 1202 1203 1204 1205
}

// 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.
1206
func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
1207
	if args.Nonce == nil {
1208 1209 1210 1211
		// 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)
1212
	}
1213 1214
	if err := args.setDefaults(ctx, s.b); err != nil {
		return nil, err
1215
	}
1216
	tx, err := s.sign(args.From, args.toTransaction())
1217 1218 1219
	if err != nil {
		return nil, err
	}
1220
	data, err := rlp.EncodeToBytes(tx)
1221 1222 1223
	if err != nil {
		return nil, err
	}
1224
	return &SignTransactionResult{data, tx}, nil
1225 1226 1227 1228
}

// PendingTransactions returns the transactions that are in the transaction pool and have a from address that is one of
// the accounts this node manages.
1229 1230 1231 1232 1233 1234
func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return nil, err
	}

1235 1236
	transactions := make([]*RPCTransaction, 0, len(pending))
	for _, tx := range pending {
1237 1238 1239 1240 1241
		var signer types.Signer = types.HomesteadSigner{}
		if tx.Protected() {
			signer = types.NewEIP155Signer(tx.ChainId())
		}
		from, _ := types.Sender(signer, tx)
1242
		if _, err := s.b.AccountManager().Find(accounts.Account{Address: from}); err == nil {
1243 1244 1245
			transactions = append(transactions, newRPCPendingTransaction(tx))
		}
	}
1246
	return transactions, nil
1247 1248
}

1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
// 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()
1259 1260 1261 1262 1263
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return common.Hash{}, err
	}

1264
	for _, p := range pending {
1265 1266 1267 1268
		var signer types.Signer = types.HomesteadSigner{}
		if p.Protected() {
			signer = types.NewEIP155Signer(p.ChainId())
		}
1269
		wantSigHash := signer.Hash(matchTx)
1270

1271 1272 1273 1274
		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
1275
			}
1276 1277
			if gasLimit != nil {
				sendArgs.Gas = gasLimit
1278
			}
1279
			signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
			if err != nil {
				return common.Hash{}, err
			}
			if err = s.b.SendTx(ctx, signedTx); err != nil {
				return common.Hash{}, err
			}
			return signedTx.Hash(), nil
		}
	}

1290
	return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash())
1291 1292
}

1293
// PublicDebugAPI is the collection of Ethereum APIs exposed over the public
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
// 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)
	}
1324
	return block.String(), nil
1325 1326 1327 1328 1329 1330 1331 1332
}

// 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)
	}
1333
	return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil
1334 1335
}

1336
// PrivateDebugAPI is the collection of Ethereum APIs exposed over the private
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
// 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)
}

1364 1365 1366 1367 1368 1369 1370 1371
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++ {
1372
		log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
1373 1374
		err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}})
		if err != nil {
1375
			log.Error("Database compaction failed", "err", err)
1376 1377 1378 1379 1380 1381
			return err
		}
	}
	return nil
}

1382
// SetHead rewinds the head of the blockchain to a previous block.
1383 1384
func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
	api.b.SetHead(uint64(number))
1385 1386 1387 1388 1389
}

// PublicNetAPI offers network related RPC methods
type PublicNetAPI struct {
	net            *p2p.Server
1390
	networkVersion uint64
1391 1392 1393
}

// NewPublicNetAPI creates a new net API instance.
1394
func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
1395 1396 1397 1398 1399 1400 1401 1402 1403
	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
1404 1405
func (s *PublicNetAPI) PeerCount() hexutil.Uint {
	return hexutil.Uint(s.net.PeerCount())
1406 1407 1408 1409 1410 1411
}

// Version returns the current ethereum protocol version.
func (s *PublicNetAPI) Version() string {
	return fmt.Sprintf("%d", s.networkVersion)
}