api.go 52.6 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
	"fmt"
	"math/big"
	"strings"
	"time"

28
	"github.com/davecgh/go-spew/spew"
29
	"github.com/ethereum/go-ethereum/accounts"
30
	"github.com/ethereum/go-ethereum/accounts/keystore"
31
	"github.com/ethereum/go-ethereum/common"
32
	"github.com/ethereum/go-ethereum/common/hexutil"
33
	"github.com/ethereum/go-ethereum/common/math"
34
	"github.com/ethereum/go-ethereum/consensus/ethash"
35
	"github.com/ethereum/go-ethereum/core"
36
	"github.com/ethereum/go-ethereum/core/rawdb"
37 38 39
	"github.com/ethereum/go-ethereum/core/types"
	"github.com/ethereum/go-ethereum/core/vm"
	"github.com/ethereum/go-ethereum/crypto"
40
	"github.com/ethereum/go-ethereum/log"
41
	"github.com/ethereum/go-ethereum/p2p"
42
	"github.com/ethereum/go-ethereum/params"
43 44 45
	"github.com/ethereum/go-ethereum/rlp"
	"github.com/ethereum/go-ethereum/rpc"
	"github.com/syndtr/goleveldb/leveldb"
46
	"github.com/syndtr/goleveldb/leveldb/util"
47 48
)

49
const (
50
	defaultGasPrice = 50 * params.Shannon
51
)
52

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

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

// GasPrice returns a suggestion for a gas price.
65 66 67
func (s *PublicEthereumAPI) GasPrice(ctx context.Context) (*hexutil.Big, error) {
	price, err := s.b.SuggestPrice(ctx)
	return (*hexutil.Big)(price), err
68 69 70
}

// ProtocolVersion returns the current Ethereum protocol version this node supports
71 72
func (s *PublicEthereumAPI) ProtocolVersion() hexutil.Uint {
	return hexutil.Uint(s.b.ProtocolVersion())
73 74 75 76 77 78 79 80 81 82
}

// 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) {
83
	progress := s.b.Downloader().Progress()
84 85

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

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

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

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

// 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 {
206 207 208
	am        *accounts.Manager
	nonceLock *AddrLocker
	b         Backend
209 210 211
}

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

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

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

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

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

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

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

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

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

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

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

339
// signTransactions sets defaults and signs the given transaction
340 341 342
// NOTE: the caller needs to ensure that the nonceLock is held, if applicable,
// and release it after the transaction has been submitted to the tx pool
func (s *PrivateAccountAPI) signTransaction(ctx context.Context, args SendTxArgs, passwd string) (*types.Transaction, error) {
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 {
347
		return nil, err
348 349 350
	}
	// Set some sanity defaults and terminate on failure
	if err := args.setDefaults(ctx, s.b); err != nil {
351
		return nil, err
352
	}
353
	// Assemble the transaction and sign with the wallet
354
	tx := args.toTransaction()
355 356 357

	var chainID *big.Int
	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
358
		chainID = config.ChainID
359
	}
360 361 362 363 364 365 366 367 368 369 370 371 372 373
	return wallet.SignTxWithPassphrase(account, passwd, tx, chainID)
}

// SendTransaction will create a transaction from the given arguments and
// tries to sign it with the key associated with args.To. If the given passwd isn't
// able to decrypt the key it fails.
func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
	if args.Nonce == nil {
		// Hold the addresse's mutex around signing to prevent concurrent assignment of
		// the same nonce to multiple accounts.
		s.nonceLock.LockAddr(args.From)
		defer s.nonceLock.UnlockAddr(args.From)
	}
	signed, err := s.signTransaction(ctx, args, passwd)
374 375 376
	if err != nil {
		return common.Hash{}, err
	}
377
	return submitTransaction(ctx, s.b, signed)
378 379
}

380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
// SignTransaction will create a transaction from the given arguments and
// tries to sign it with the key associated with args.To. If the given passwd isn't
// able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast
// to other nodes
func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args SendTxArgs, passwd string) (*SignTransactionResult, error) {
	// No need to obtain the noncelock mutex, since we won't be sending this
	// tx into the transaction pool, but right back to the user
	if args.Gas == nil {
		return nil, fmt.Errorf("gas not specified")
	}
	if args.GasPrice == nil {
		return nil, fmt.Errorf("gasPrice not specified")
	}
	if args.Nonce == nil {
		return nil, fmt.Errorf("nonce not specified")
	}
	signed, err := s.signTransaction(ctx, args, passwd)
	if err != nil {
		return nil, err
	}
	data, err := rlp.EncodeToBytes(signed)
	if err != nil {
		return nil, err
	}
	return &SignTransactionResult{data, signed}, nil
}

407
// signHash is a helper function that calculates a hash for the given message that can be
408 409 410 411 412 413 414
// 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 {
415 416 417 418 419 420 421
	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))
//
422 423 424
// 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.
//
425 426 427
// The key used to calculate the signature is decrypted with the given password.
//
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign
428
func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {
429 430 431 432 433 434 435 436 437
	// 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))
438 439 440
	if err != nil {
		return nil, err
	}
441
	signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
442
	return signature, nil
443 444 445 446 447 448 449 450
}

// 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)
//
451 452 453
// 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.
//
454
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover
455
func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {
456 457 458
	if len(sig) != 65 {
		return common.Address{}, fmt.Errorf("signature must be 65 bytes long")
	}
459 460
	if sig[64] != 27 && sig[64] != 28 {
		return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)")
461
	}
462
	sig[64] -= 27 // Transform yellow paper V from 27/28 to 0/1
463

464
	rpk, err := crypto.SigToPub(signHash(data), sig)
465 466 467
	if err != nil {
		return common.Address{}, err
	}
468
	return crypto.PubkeyToAddress(*rpk), nil
469 470
}

471 472 473 474 475 476
// 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)
}

477 478 479
// 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 {
480
	b Backend
481 482
}

483
// NewPublicBlockChainAPI creates a new Ethereum blockchain API.
484
func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI {
485
	return &PublicBlockChainAPI{b}
486 487 488
}

// BlockNumber returns the block number of the chain head.
489
func (s *PublicBlockChainAPI) BlockNumber() hexutil.Uint64 {
490
	header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available
491
	return hexutil.Uint64(header.Number.Uint64())
492 493 494 495 496
}

// 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.
497
func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Big, error) {
498
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
499 500 501
	if state == nil || err != nil {
		return nil, err
	}
502
	return (*hexutil.Big)(state.GetBalance(address)), state.Error()
503 504 505 506 507 508 509 510 511 512
}

// 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
513
			for _, field := range []string{"hash", "nonce", "miner"} {
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
				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.
534
func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {
535 536 537
	block, err := s.b.BlockByNumber(ctx, blockNr)
	if block != nil {
		uncles := block.Uncles()
538
		if index >= hexutil.Uint(len(uncles)) {
539
			log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index)
540 541
			return nil, nil
		}
542
		block = types.NewBlockWithHeader(uncles[index])
543 544 545 546 547 548 549
		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.
550
func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {
551 552 553
	block, err := s.b.GetBlock(ctx, blockHash)
	if block != nil {
		uncles := block.Uncles()
554
		if index >= hexutil.Uint(len(uncles)) {
555
			log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index)
556 557
			return nil, nil
		}
558
		block = types.NewBlockWithHeader(uncles[index])
559 560 561 562 563 564
		return s.rpcOutputBlock(block, false, false)
	}
	return nil, err
}

// GetUncleCountByBlockNumber returns number of uncles in the block for the given block number
565
func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
566
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
567 568
		n := hexutil.Uint(len(block.Uncles()))
		return &n
569 570 571 572 573
	}
	return nil
}

// GetUncleCountByBlockHash returns number of uncles in the block for the given block hash
574
func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
575
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
576 577
		n := hexutil.Uint(len(block.Uncles()))
		return &n
578 579 580 581 582
	}
	return nil
}

// GetCode returns the code stored at the given address in the state for the given block number.
583
func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
584
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
585
	if state == nil || err != nil {
586
		return nil, err
587
	}
588 589
	code := state.GetCode(address)
	return code, state.Error()
590 591 592 593 594
}

// 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.
595
func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
596
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
597
	if state == nil || err != nil {
598
		return nil, err
599
	}
600 601
	res := state.GetState(address, common.HexToHash(key))
	return res[:], state.Error()
602 603 604 605 606 607
}

// CallArgs represents the arguments for a call.
type CallArgs struct {
	From     common.Address  `json:"from"`
	To       *common.Address `json:"to"`
608
	Gas      hexutil.Uint64  `json:"gas"`
609 610
	GasPrice hexutil.Big     `json:"gasPrice"`
	Value    hexutil.Big     `json:"value"`
611
	Data     hexutil.Bytes   `json:"data"`
612 613
}

614
func (s *PublicBlockChainAPI) doCall(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber, vmCfg vm.Config, timeout time.Duration) ([]byte, uint64, bool, error) {
615
	defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now())
616

617
	state, header, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
618
	if state == nil || err != nil {
619
		return nil, 0, false, err
620
	}
621 622 623
	// Set sender address or use a default if none specified
	addr := args.From
	if addr == (common.Address{}) {
624 625 626 627
		if wallets := s.b.AccountManager().Wallets(); len(wallets) > 0 {
			if accounts := wallets[0].Accounts(); len(accounts) > 0 {
				addr = accounts[0].Address
			}
628 629
		}
	}
630
	// Set default gas & gas price if none were set
631 632
	gas, gasPrice := uint64(args.Gas), args.GasPrice.ToInt()
	if gas == 0 {
633
		gas = math.MaxUint64 / 2
634
	}
635
	if gasPrice.Sign() == 0 {
636
		gasPrice = new(big.Int).SetUint64(defaultGasPrice)
637
	}
638 639

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

642 643 644
	// 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
645 646
	if timeout > 0 {
		ctx, cancel = context.WithTimeout(ctx, timeout)
647 648
	} else {
		ctx, cancel = context.WithCancel(ctx)
649
	}
650 651
	// Make sure the context is cancelled when the call has completed
	// this makes sure resources are cleaned up.
652
	defer cancel()
653 654 655 656

	// Get a new instance of the EVM.
	evm, vmError, err := s.b.GetEVM(ctx, msg, state, header, vmCfg)
	if err != nil {
657
		return nil, 0, false, err
658 659 660 661
	}
	// Wait for the context to be done and cancel the evm. Even if the
	// EVM has finished, cancelling may be done (repeatedly)
	go func() {
662 663
		<-ctx.Done()
		evm.Cancel()
664 665 666 667
	}()

	// Setup the gas pool (also for unmetered requests)
	// and apply the message.
668
	gp := new(core.GasPool).AddGas(math.MaxUint64)
669
	res, gas, failed, err := core.ApplyMessage(evm, msg, gp)
670
	if err := vmError(); err != nil {
671
		return nil, 0, false, err
672
	}
673
	return res, gas, failed, err
674 675 676
}

// Call executes the given transaction on the state for the given block number.
677
// It doesn't make and changes in the state/blockchain and is useful to execute and retrieve values.
678
func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
679
	result, _, _, err := s.doCall(ctx, args, blockNr, vm.Config{}, 5*time.Second)
680
	return (hexutil.Bytes)(result), err
681 682
}

683 684
// EstimateGas returns an estimate of the amount of gas needed to execute the
// given transaction against the current pending block.
685 686
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
687
	var (
688 689 690
		lo  uint64 = params.TxGas - 1
		hi  uint64
		cap uint64
691
	)
692 693
	if uint64(args.Gas) >= params.TxGas {
		hi = uint64(args.Gas)
694 695 696 697
	} else {
		// Retrieve the current pending block to act as the gas ceiling
		block, err := s.b.BlockByNumber(ctx, rpc.PendingBlockNumber)
		if err != nil {
698
			return 0, err
699
		}
700
		hi = block.GasLimit()
701
	}
702
	cap = hi
703

704 705
	// Create a helper to check if a gas allowance results in an executable transaction
	executable := func(gas uint64) bool {
706 707
		args.Gas = hexutil.Uint64(gas)

708
		_, _, failed, err := s.doCall(ctx, args, rpc.PendingBlockNumber, vm.Config{}, 0)
709
		if err != nil || failed {
710 711 712 713 714 715 716 717
			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) {
718
			lo = mid
719 720 721 722 723 724 725
		} else {
			hi = mid
		}
	}
	// Reject the transaction as invalid if it still fails at the highest allowance
	if hi == cap {
		if !executable(hi) {
726
			return 0, fmt.Errorf("gas required exceeds allowance or always failing transaction")
727 728
		}
	}
729
	return hexutil.Uint64(hi), nil
730 731 732
}

// ExecutionResult groups all structured logs emitted by the EVM
733 734
// while replaying a transaction in debug mode as well as transaction
// execution status, the amount of gas used and the return value
735
type ExecutionResult struct {
736
	Gas         uint64         `json:"gas"`
737
	Failed      bool           `json:"failed"`
738 739 740 741 742 743 744
	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 {
745 746 747 748 749 750 751 752 753
	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"`
754 755 756
}

// formatLogs formats EVM returned structured logs for json output
757 758 759 760
func FormatLogs(logs []vm.StructLog) []StructLogRes {
	formatted := make([]StructLogRes, len(logs))
	for index, trace := range logs {
		formatted[index] = StructLogRes{
761 762 763 764 765 766 767
			Pc:      trace.Pc,
			Op:      trace.Op.String(),
			Gas:     trace.Gas,
			GasCost: trace.GasCost,
			Depth:   trace.Depth,
			Error:   trace.Err,
		}
768 769 770 771 772 773
		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
774
		}
775 776 777 778 779 780
		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
781
		}
782 783 784 785 786 787
		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
788 789
		}
	}
790
	return formatted
791 792
}

793
// RPCMarshalBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are
794 795
// returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain
// transaction hashes.
796
func RPCMarshalBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
797
	head := b.Header() // copies the header once
798
	fields := map[string]interface{}{
799
		"number":           (*hexutil.Big)(head.Number),
800
		"hash":             b.Hash(),
801 802 803 804 805 806 807
		"parentHash":       head.ParentHash,
		"nonce":            head.Nonce,
		"mixHash":          head.MixDigest,
		"sha3Uncles":       head.UncleHash,
		"logsBloom":        head.Bloom,
		"stateRoot":        head.Root,
		"miner":            head.Coinbase,
808
		"difficulty":       (*hexutil.Big)(head.Difficulty),
809
		"extraData":        hexutil.Bytes(head.Extra),
810
		"size":             hexutil.Uint64(b.Size()),
811 812
		"gasLimit":         hexutil.Uint64(head.GasLimit),
		"gasUsed":          hexutil.Uint64(head.GasUsed),
813
		"timestamp":        (*hexutil.Big)(head.Time),
814
		"transactionsRoot": head.TxHash,
815
		"receiptsRoot":     head.ReceiptHash,
816 817 818 819 820 821 822 823
	}

	if inclTx {
		formatTx := func(tx *types.Transaction) (interface{}, error) {
			return tx.Hash(), nil
		}
		if fullTx {
			formatTx = func(tx *types.Transaction) (interface{}, error) {
824
				return newRPCTransactionFromBlockHash(b, tx.Hash()), nil
825 826 827 828 829
			}
		}
		txs := b.Transactions()
		transactions := make([]interface{}, len(txs))
		var err error
830
		for i, tx := range txs {
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
			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
}

848 849 850 851 852 853 854 855 856 857 858
// rpcOutputBlock uses the generalized output filler, then adds the total difficulty field, which requires
// a `PublicBlockchainAPI`.
func (s *PublicBlockChainAPI) rpcOutputBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
	fields, err := RPCMarshalBlock(b, inclTx, fullTx)
	if err != nil {
		return nil, err
	}
	fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(b.Hash()))
	return fields, err
}

859 860 861
// RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction
type RPCTransaction struct {
	BlockHash        common.Hash     `json:"blockHash"`
862
	BlockNumber      *hexutil.Big    `json:"blockNumber"`
863
	From             common.Address  `json:"from"`
864
	Gas              hexutil.Uint64  `json:"gas"`
865
	GasPrice         *hexutil.Big    `json:"gasPrice"`
866
	Hash             common.Hash     `json:"hash"`
867
	Input            hexutil.Bytes   `json:"input"`
868
	Nonce            hexutil.Uint64  `json:"nonce"`
869
	To               *common.Address `json:"to"`
870 871 872 873 874
	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"`
875 876
}

877 878 879
// 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 {
880 881 882 883 884
	var signer types.Signer = types.FrontierSigner{}
	if tx.Protected() {
		signer = types.NewEIP155Signer(tx.ChainId())
	}
	from, _ := types.Sender(signer, tx)
885
	v, r, s := tx.RawSignatureValues()
886 887

	result := &RPCTransaction{
888
		From:     from,
889
		Gas:      hexutil.Uint64(tx.Gas()),
890
		GasPrice: (*hexutil.Big)(tx.GasPrice()),
891
		Hash:     tx.Hash(),
892
		Input:    hexutil.Bytes(tx.Data()),
893
		Nonce:    hexutil.Uint64(tx.Nonce()),
894
		To:       tx.To(),
895 896 897 898
		Value:    (*hexutil.Big)(tx.Value()),
		V:        (*hexutil.Big)(v),
		R:        (*hexutil.Big)(r),
		S:        (*hexutil.Big)(s),
899
	}
900 901 902 903 904 905
	if blockHash != (common.Hash{}) {
		result.BlockHash = blockHash
		result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber))
		result.TransactionIndex = hexutil.Uint(index)
	}
	return result
906 907
}

908 909 910
// 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)
911 912
}

913 914 915 916 917
// 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
918
	}
919 920
	return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index)
}
921

922 923 924 925 926 927 928 929
// 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
930 931
}

932 933
// newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction {
934
	for idx, tx := range b.Transactions() {
935 936
		if tx.Hash() == hash {
			return newRPCTransactionFromBlockIndex(b, uint64(idx))
937 938
		}
	}
939
	return nil
940 941 942 943
}

// PublicTransactionPoolAPI exposes methods for the RPC interface
type PublicTransactionPoolAPI struct {
944 945
	b         Backend
	nonceLock *AddrLocker
946 947 948
}

// NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
949 950
func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI {
	return &PublicTransactionPoolAPI{b, nonceLock}
951 952 953
}

// GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
954
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
955
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
956 957
		n := hexutil.Uint(len(block.Transactions()))
		return &n
958 959 960 961 962
	}
	return nil
}

// GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
963
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
964
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
965 966
		n := hexutil.Uint(len(block.Transactions()))
		return &n
967 968 969 970 971
	}
	return nil
}

// GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
972
func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
973
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
974
		return newRPCTransactionFromBlockIndex(block, uint64(index))
975
	}
976
	return nil
977 978 979
}

// GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
980
func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
981
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
982
		return newRPCTransactionFromBlockIndex(block, uint64(index))
983
	}
984
	return nil
985 986
}

987
// GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
988
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
989
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
990
		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
991
	}
992
	return nil
993 994 995
}

// GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
996
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
997
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
998
		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
999
	}
1000
	return nil
1001 1002
}

1003
// GetTransactionCount returns the number of transactions the given address has sent for the given block number
1004
func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) {
1005
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
1006 1007 1008
	if state == nil || err != nil {
		return nil, err
	}
1009 1010
	nonce := state.GetNonce(address)
	return (*hexutil.Uint64)(&nonce), state.Error()
1011 1012 1013
}

// GetTransactionByHash returns the transaction for the given hash
1014 1015
func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) *RPCTransaction {
	// Try to return an already finalized transaction
1016
	if tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash); tx != nil {
1017
		return newRPCTransaction(tx, blockHash, blockNumber, index)
1018
	}
1019 1020 1021
	// No finalized transaction, try to retrieve it from the pool
	if tx := s.b.GetPoolTransaction(hash); tx != nil {
		return newRPCPendingTransaction(tx)
1022
	}
1023 1024
	// Transaction unknown, return as such
	return nil
1025 1026
}

1027
// GetRawTransactionByHash returns the bytes of the transaction for the given hash.
1028
func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
1029 1030
	var tx *types.Transaction

1031
	// Retrieve a finalized transaction, or a pooled otherwise
1032
	if tx, _, _, _ = rawdb.ReadTransaction(s.b.ChainDb(), hash); tx == nil {
1033 1034 1035 1036
		if tx = s.b.GetPoolTransaction(hash); tx == nil {
			// Transaction not found anywhere, abort
			return nil, nil
		}
1037
	}
1038
	// Serialize to RLP and return
1039 1040 1041
	return rlp.EncodeToBytes(tx)
}

1042
// GetTransactionReceipt returns the transaction receipt for the given transaction hash.
1043
func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {
1044
	tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash)
1045
	if tx == nil {
1046
		return nil, nil
1047
	}
1048 1049 1050 1051 1052
	receipts, err := s.b.GetReceipts(ctx, blockHash)
	if err != nil {
		return nil, err
	}
	if len(receipts) <= int(index) {
1053
		return nil, nil
1054
	}
1055
	receipt := receipts[index]
1056

1057 1058 1059
	var signer types.Signer = types.FrontierSigner{}
	if tx.Protected() {
		signer = types.NewEIP155Signer(tx.ChainId())
1060
	}
1061
	from, _ := types.Sender(signer, tx)
1062 1063

	fields := map[string]interface{}{
1064 1065
		"blockHash":         blockHash,
		"blockNumber":       hexutil.Uint64(blockNumber),
1066
		"transactionHash":   hash,
1067
		"transactionIndex":  hexutil.Uint64(index),
1068 1069
		"from":              from,
		"to":                tx.To(),
1070 1071
		"gasUsed":           hexutil.Uint64(receipt.GasUsed),
		"cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed),
1072 1073
		"contractAddress":   nil,
		"logs":              receipt.Logs,
1074
		"logsBloom":         receipt.Bloom,
1075
	}
1076 1077 1078 1079 1080

	// Assign receipt status or post state.
	if len(receipt.PostState) > 0 {
		fields["root"] = hexutil.Bytes(receipt.PostState)
	} else {
1081
		fields["status"] = hexutil.Uint(receipt.Status)
1082
	}
1083
	if receipt.Logs == nil {
1084
		fields["logs"] = [][]*types.Log{}
1085 1086
	}
	// If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
1087
	if receipt.ContractAddress != (common.Address{}) {
1088 1089 1090 1091 1092 1093 1094
		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) {
1095 1096 1097 1098 1099 1100 1101 1102
	// 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
1103 1104
	var chainID *big.Int
	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
1105
		chainID = config.ChainID
1106
	}
1107
	return wallet.SignTx(account, tx, chainID)
1108 1109 1110 1111 1112 1113
}

// 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"`
1114
	Gas      *hexutil.Uint64 `json:"gas"`
1115 1116 1117
	GasPrice *hexutil.Big    `json:"gasPrice"`
	Value    *hexutil.Big    `json:"value"`
	Nonce    *hexutil.Uint64 `json:"nonce"`
1118 1119 1120 1121
	// 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"`
1122 1123
}

1124
// setDefaults is a helper function that fills in default values for unspecified tx fields.
1125
func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
1126
	if args.Gas == nil {
1127 1128
		args.Gas = new(hexutil.Uint64)
		*(*uint64)(args.Gas) = 90000
1129 1130 1131 1132
	}
	if args.GasPrice == nil {
		price, err := b.SuggestPrice(ctx)
		if err != nil {
1133
			return err
1134
		}
1135
		args.GasPrice = (*hexutil.Big)(price)
1136 1137
	}
	if args.Value == nil {
1138 1139 1140 1141 1142 1143 1144 1145 1146
		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)
	}
1147 1148 1149
	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.`)
	}
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
	if args.To == nil {
		// Contract creation
		var input []byte
		if args.Data != nil {
			input = *args.Data
		} else if args.Input != nil {
			input = *args.Input
		}
		if len(input) == 0 {
			return errors.New(`contract creation without any data provided`)
		}
	}
1162 1163 1164 1165
	return nil
}

func (args *SendTxArgs) toTransaction() *types.Transaction {
1166 1167 1168 1169 1170 1171
	var input []byte
	if args.Data != nil {
		input = *args.Data
	} else if args.Input != nil {
		input = *args.Input
	}
1172
	if args.To == nil {
1173
		return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
1174
	}
1175
	return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
1176 1177
}

1178
// submitTransaction is a helper function that submits tx to txPool and logs a message.
1179 1180
func submitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) {
	if err := b.SendTx(ctx, tx); err != nil {
1181 1182
		return common.Hash{}, err
	}
1183 1184
	if tx.To() == nil {
		signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
1185 1186 1187 1188
		from, err := types.Sender(signer, tx)
		if err != nil {
			return common.Hash{}, err
		}
1189
		addr := crypto.CreateAddress(from, tx.Nonce())
1190
		log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
1191
	} else {
1192
		log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
1193
	}
1194
	return tx.Hash(), nil
1195 1196 1197 1198 1199
}

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

1201 1202 1203 1204 1205 1206 1207
	// 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
	}
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219

	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
	}
1220
	// Assemble the transaction and sign with the wallet
1221
	tx := args.toTransaction()
1222 1223 1224

	var chainID *big.Int
	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
1225
		chainID = config.ChainID
1226
	}
1227
	signed, err := wallet.SignTx(account, tx, chainID)
1228 1229 1230
	if err != nil {
		return common.Hash{}, err
	}
1231
	return submitTransaction(ctx, s.b, signed)
1232 1233 1234 1235
}

// SendRawTransaction will add the signed transaction to the transaction pool.
// The sender is responsible for signing the transaction and using the correct nonce.
1236
func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) {
1237
	tx := new(types.Transaction)
1238
	if err := rlp.DecodeBytes(encodedTx, tx); err != nil {
1239
		return common.Hash{}, err
1240
	}
1241
	return submitTransaction(ctx, s.b, tx)
1242 1243
}

1244 1245 1246
// Sign calculates an ECDSA signature for:
// keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
//
1247 1248 1249
// 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.
//
1250 1251 1252
// The account associated with addr must be unlocked.
//
// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
1253
func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
1254 1255 1256 1257 1258 1259 1260 1261 1262
	// 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))
1263
	if err == nil {
1264
		signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
1265 1266
	}
	return signature, err
1267 1268 1269 1270
}

// SignTransactionResult represents a RLP encoded signed transaction.
type SignTransactionResult struct {
1271 1272
	Raw hexutil.Bytes      `json:"raw"`
	Tx  *types.Transaction `json:"tx"`
1273 1274 1275 1276 1277
}

// 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.
1278
func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
1279 1280 1281 1282 1283 1284
	if args.Gas == nil {
		return nil, fmt.Errorf("gas not specified")
	}
	if args.GasPrice == nil {
		return nil, fmt.Errorf("gasPrice not specified")
	}
1285
	if args.Nonce == nil {
1286
		return nil, fmt.Errorf("nonce not specified")
1287
	}
1288 1289
	if err := args.setDefaults(ctx, s.b); err != nil {
		return nil, err
1290
	}
1291
	tx, err := s.sign(args.From, args.toTransaction())
1292 1293 1294
	if err != nil {
		return nil, err
	}
1295
	data, err := rlp.EncodeToBytes(tx)
1296 1297 1298
	if err != nil {
		return nil, err
	}
1299
	return &SignTransactionResult{data, tx}, nil
1300 1301
}

1302 1303
// PendingTransactions returns the transactions that are in the transaction pool
// and have a from address that is one of the accounts this node manages.
1304 1305 1306 1307 1308
func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return nil, err
	}
1309 1310 1311 1312 1313 1314
	accounts := make(map[common.Address]struct{})
	for _, wallet := range s.b.AccountManager().Wallets() {
		for _, account := range wallet.Accounts() {
			accounts[account.Address] = struct{}{}
		}
	}
1315 1316
	transactions := make([]*RPCTransaction, 0, len(pending))
	for _, tx := range pending {
1317 1318 1319 1320 1321
		var signer types.Signer = types.HomesteadSigner{}
		if tx.Protected() {
			signer = types.NewEIP155Signer(tx.ChainId())
		}
		from, _ := types.Sender(signer, tx)
1322
		if _, exists := accounts[from]; exists {
1323 1324 1325
			transactions = append(transactions, newRPCPendingTransaction(tx))
		}
	}
1326
	return transactions, nil
1327 1328
}

1329 1330
// 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.
1331
func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {
1332 1333 1334 1335 1336 1337 1338
	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()
1339 1340 1341 1342 1343
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return common.Hash{}, err
	}

1344
	for _, p := range pending {
1345 1346 1347 1348
		var signer types.Signer = types.HomesteadSigner{}
		if p.Protected() {
			signer = types.NewEIP155Signer(p.ChainId())
		}
1349
		wantSigHash := signer.Hash(matchTx)
1350

1351 1352
		if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash {
			// Match. Re-sign and send the transaction.
1353
			if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 {
1354
				sendArgs.GasPrice = gasPrice
1355
			}
1356
			if gasLimit != nil && *gasLimit != 0 {
1357
				sendArgs.Gas = gasLimit
1358
			}
1359
			signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
			if err != nil {
				return common.Hash{}, err
			}
			if err = s.b.SendTx(ctx, signedTx); err != nil {
				return common.Hash{}, err
			}
			return signedTx.Hash(), nil
		}
	}

1370
	return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash())
1371 1372
}

1373
// PublicDebugAPI is the collection of Ethereum APIs exposed over the public
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
// 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)
	}
1404
	return spew.Sdump(block), nil
1405 1406 1407 1408 1409 1410 1411 1412
}

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

1416
// PrivateDebugAPI is the collection of Ethereum APIs exposed over the private
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
// 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)
}

1444 1445 1446 1447 1448 1449 1450 1451
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++ {
1452
		log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
1453 1454
		err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}})
		if err != nil {
1455
			log.Error("Database compaction failed", "err", err)
1456 1457 1458 1459 1460 1461
			return err
		}
	}
	return nil
}

1462
// SetHead rewinds the head of the blockchain to a previous block.
1463 1464
func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
	api.b.SetHead(uint64(number))
1465 1466 1467 1468 1469
}

// PublicNetAPI offers network related RPC methods
type PublicNetAPI struct {
	net            *p2p.Server
1470
	networkVersion uint64
1471 1472 1473
}

// NewPublicNetAPI creates a new net API instance.
1474
func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
1475 1476 1477 1478 1479 1480 1481 1482 1483
	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
1484 1485
func (s *PublicNetAPI) PeerCount() hexutil.Uint {
	return hexutil.Uint(s.net.PeerCount())
1486 1487 1488 1489 1490 1491
}

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