api.go 50.4 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
	"bytes"
21
	"context"
22
	"errors"
23 24 25 26 27 28
	"fmt"
	"math/big"
	"strings"
	"time"

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

47
const (
48
	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
	Gas      hexutil.Uint64  `json:"gas"`
578 579
	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, uint64, 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, 0, 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 601 602
	gas, gasPrice := uint64(args.Gas), args.GasPrice.ToInt()
	if gas == 0 {
		gas = 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, 0, 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.MaxUint64)
638
	res, gas, failed, err := core.ApplyMessage(evm, msg, gp)
639
	if err := vmError(); err != nil {
640
		return nil, 0, 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 655
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
656
	var (
657 658 659
		lo  uint64 = params.TxGas - 1
		hi  uint64
		cap uint64
660
	)
661 662
	if uint64(args.Gas) >= params.TxGas {
		hi = uint64(args.Gas)
663 664 665 666
	} else {
		// Retrieve the current pending block to act as the gas ceiling
		block, err := s.b.BlockByNumber(ctx, rpc.PendingBlockNumber)
		if err != nil {
667
			return 0, err
668
		}
669
		hi = block.GasLimit()
670
	}
671
	cap = hi
672

673 674
	// Create a helper to check if a gas allowance results in an executable transaction
	executable := func(gas uint64) bool {
675 676
		args.Gas = hexutil.Uint64(gas)

677 678
		_, _, failed, err := s.doCall(ctx, args, rpc.PendingBlockNumber, vm.Config{})
		if err != nil || failed {
679 680 681 682 683 684 685 686
			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) {
687
			lo = mid
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) {
695
			return 0, fmt.Errorf("gas required exceeds allowance or always failing transaction")
696 697
		}
	}
698
	return hexutil.Uint64(hi), nil
699 700 701
}

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

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

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

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

		if fullTx {
			formatTx = func(tx *types.Transaction) (interface{}, error) {
795
				return newRPCTransactionFromBlockHash(b, tx.Hash()), nil
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 822
			}
		}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1014 1015 1016
	var signer types.Signer = types.FrontierSigner{}
	if tx.Protected() {
		signer = types.NewEIP155Signer(tx.ChainId())
1017
	}
1018
	from, _ := types.Sender(signer, tx)
1019 1020

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

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

// 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"`
1071
	Gas      *hexutil.Uint64 `json:"gas"`
1072 1073 1074
	GasPrice *hexutil.Big    `json:"gasPrice"`
	Value    *hexutil.Big    `json:"value"`
	Nonce    *hexutil.Uint64 `json:"nonce"`
1075 1076 1077 1078
	// 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"`
1079 1080
}

1081
// setDefaults is a helper function that fills in default values for unspecified tx fields.
1082
func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
1083
	if args.Gas == nil {
1084 1085
		args.Gas = new(hexutil.Uint64)
		*(*uint64)(args.Gas) = 90000
1086 1087 1088 1089
	}
	if args.GasPrice == nil {
		price, err := b.SuggestPrice(ctx)
		if err != nil {
1090
			return err
1091
		}
1092
		args.GasPrice = (*hexutil.Big)(price)
1093 1094
	}
	if args.Value == nil {
1095 1096 1097 1098 1099 1100 1101 1102 1103
		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)
	}
1104 1105 1106
	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.`)
	}
1107 1108 1109 1110
	return nil
}

func (args *SendTxArgs) toTransaction() *types.Transaction {
1111 1112 1113 1114 1115 1116
	var input []byte
	if args.Data != nil {
		input = *args.Data
	} else if args.Input != nil {
		input = *args.Input
	}
1117
	if args.To == nil {
1118
		return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
1119
	}
1120
	return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
1121 1122
}

1123
// submitTransaction is a helper function that submits tx to txPool and logs a message.
1124 1125
func submitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) {
	if err := b.SendTx(ctx, tx); err != nil {
1126 1127
		return common.Hash{}, err
	}
1128 1129
	if tx.To() == nil {
		signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
1130 1131 1132 1133
		from, err := types.Sender(signer, tx)
		if err != nil {
			return common.Hash{}, err
		}
1134
		addr := crypto.CreateAddress(from, tx.Nonce())
1135
		log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
1136
	} else {
1137
		log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
1138
	}
1139
	return tx.Hash(), nil
1140 1141 1142 1143 1144
}

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

1146 1147 1148 1149 1150 1151 1152
	// 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
	}
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164

	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
	}
1165
	// Assemble the transaction and sign with the wallet
1166
	tx := args.toTransaction()
1167 1168 1169 1170 1171

	var chainID *big.Int
	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
		chainID = config.ChainId
	}
1172
	signed, err := wallet.SignTx(account, tx, chainID)
1173 1174 1175
	if err != nil {
		return common.Hash{}, err
	}
1176
	return submitTransaction(ctx, s.b, signed)
1177 1178 1179 1180
}

// SendRawTransaction will add the signed transaction to the transaction pool.
// The sender is responsible for signing the transaction and using the correct nonce.
1181
func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) {
1182
	tx := new(types.Transaction)
1183
	if err := rlp.DecodeBytes(encodedTx, tx); err != nil {
1184
		return common.Hash{}, err
1185
	}
1186
	return submitTransaction(ctx, s.b, tx)
1187 1188
}

1189 1190 1191
// Sign calculates an ECDSA signature for:
// keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
//
1192 1193 1194
// 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.
//
1195 1196 1197
// The account associated with addr must be unlocked.
//
// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
1198
func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
1199 1200 1201 1202 1203 1204 1205 1206 1207
	// 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))
1208
	if err == nil {
1209
		signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
1210 1211
	}
	return signature, err
1212 1213 1214 1215
}

// SignTransactionResult represents a RLP encoded signed transaction.
type SignTransactionResult struct {
1216 1217
	Raw hexutil.Bytes      `json:"raw"`
	Tx  *types.Transaction `json:"tx"`
1218 1219 1220 1221 1222
}

// 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.
1223
func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
1224
	if args.Nonce == nil {
1225 1226 1227 1228
		// 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)
1229
	}
1230 1231
	if err := args.setDefaults(ctx, s.b); err != nil {
		return nil, err
1232
	}
1233
	tx, err := s.sign(args.From, args.toTransaction())
1234 1235 1236
	if err != nil {
		return nil, err
	}
1237
	data, err := rlp.EncodeToBytes(tx)
1238 1239 1240
	if err != nil {
		return nil, err
	}
1241
	return &SignTransactionResult{data, tx}, nil
1242 1243 1244 1245
}

// PendingTransactions returns the transactions that are in the transaction pool and have a from address that is one of
// the accounts this node manages.
1246 1247 1248 1249 1250 1251
func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return nil, err
	}

1252 1253
	transactions := make([]*RPCTransaction, 0, len(pending))
	for _, tx := range pending {
1254 1255 1256 1257 1258
		var signer types.Signer = types.HomesteadSigner{}
		if tx.Protected() {
			signer = types.NewEIP155Signer(tx.ChainId())
		}
		from, _ := types.Sender(signer, tx)
1259
		if _, err := s.b.AccountManager().Find(accounts.Account{Address: from}); err == nil {
1260 1261 1262
			transactions = append(transactions, newRPCPendingTransaction(tx))
		}
	}
1263
	return transactions, nil
1264 1265
}

1266 1267
// 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.
1268
func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {
1269 1270 1271 1272 1273 1274 1275
	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()
1276 1277 1278 1279 1280
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return common.Hash{}, err
	}

1281
	for _, p := range pending {
1282 1283 1284 1285
		var signer types.Signer = types.HomesteadSigner{}
		if p.Protected() {
			signer = types.NewEIP155Signer(p.ChainId())
		}
1286
		wantSigHash := signer.Hash(matchTx)
1287

1288 1289 1290 1291
		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
1292
			}
1293 1294
			if gasLimit != nil {
				sendArgs.Gas = gasLimit
1295
			}
1296
			signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())
1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
			if err != nil {
				return common.Hash{}, err
			}
			if err = s.b.SendTx(ctx, signedTx); err != nil {
				return common.Hash{}, err
			}
			return signedTx.Hash(), nil
		}
	}

1307
	return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash())
1308 1309
}

1310
// PublicDebugAPI is the collection of Ethereum APIs exposed over the public
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
// 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)
	}
1341
	return block.String(), nil
1342 1343 1344 1345 1346 1347 1348 1349
}

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

1353
// PrivateDebugAPI is the collection of Ethereum APIs exposed over the private
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
// 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)
}

1381 1382 1383 1384 1385 1386 1387 1388
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++ {
1389
		log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
1390 1391
		err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}})
		if err != nil {
1392
			log.Error("Database compaction failed", "err", err)
1393 1394 1395 1396 1397 1398
			return err
		}
	}
	return nil
}

1399
// SetHead rewinds the head of the blockchain to a previous block.
1400 1401
func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
	api.b.SetHead(uint64(number))
1402 1403 1404 1405 1406
}

// PublicNetAPI offers network related RPC methods
type PublicNetAPI struct {
	net            *p2p.Server
1407
	networkVersion uint64
1408 1409 1410
}

// NewPublicNetAPI creates a new net API instance.
1411
func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
1412 1413 1414 1415 1416 1417 1418 1419 1420
	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
1421 1422
func (s *PublicNetAPI) PeerCount() hexutil.Uint {
	return hexutil.Uint(s.net.PeerCount())
1423 1424 1425 1426 1427 1428
}

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