api.go 52.1 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 65 66 67 68 69
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

338
// signTransactions sets defaults and signs the given transaction
339 340 341
// 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) {
342 343 344 345
	// Look up the wallet containing the requested signer
	account := accounts.Account{Address: args.From}
	wallet, err := s.am.Find(account)
	if err != nil {
346
		return nil, err
347 348 349
	}
	// Set some sanity defaults and terminate on failure
	if err := args.setDefaults(ctx, s.b); err != nil {
350
		return nil, err
351
	}
352
	// Assemble the transaction and sign with the wallet
353
	tx := args.toTransaction()
354 355 356 357 358

	var chainID *big.Int
	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
		chainID = config.ChainId
	}
359 360 361 362 363 364 365 366 367 368 369 370 371 372
	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)
373 374 375
	if err != nil {
		return common.Hash{}, err
	}
376
	return submitTransaction(ctx, s.b, signed)
377 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
// 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
}

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

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

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

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

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

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

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

// 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) {
499
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
500 501 502
	if state == nil || err != nil {
		return nil, err
	}
503 504
	b := state.GetBalance(address)
	return b, state.Error()
505 506 507 508 509 510 511 512 513 514
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

// 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) {
799
	head := b.Header() // copies the header once
800
	fields := map[string]interface{}{
801
		"number":           (*hexutil.Big)(head.Number),
802
		"hash":             b.Hash(),
803 804 805 806 807 808 809
		"parentHash":       head.ParentHash,
		"nonce":            head.Nonce,
		"mixHash":          head.MixDigest,
		"sha3Uncles":       head.UncleHash,
		"logsBloom":        head.Bloom,
		"stateRoot":        head.Root,
		"miner":            head.Coinbase,
810 811
		"difficulty":       (*hexutil.Big)(head.Difficulty),
		"totalDifficulty":  (*hexutil.Big)(s.b.GetTd(b.Hash())),
812
		"extraData":        hexutil.Bytes(head.Extra),
813
		"size":             hexutil.Uint64(b.Size()),
814 815
		"gasLimit":         hexutil.Uint64(head.GasLimit),
		"gasUsed":          hexutil.Uint64(head.GasUsed),
816
		"timestamp":        (*hexutil.Big)(head.Time),
817
		"transactionsRoot": head.TxHash,
818
		"receiptsRoot":     head.ReceiptHash,
819 820 821 822 823 824 825 826 827
	}

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

		if fullTx {
			formatTx = func(tx *types.Transaction) (interface{}, error) {
828
				return newRPCTransactionFromBlockHash(b, tx.Hash()), nil
829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
			}
		}

		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"`
856
	BlockNumber      *hexutil.Big    `json:"blockNumber"`
857
	From             common.Address  `json:"from"`
858
	Gas              hexutil.Uint64  `json:"gas"`
859
	GasPrice         *hexutil.Big    `json:"gasPrice"`
860
	Hash             common.Hash     `json:"hash"`
861
	Input            hexutil.Bytes   `json:"input"`
862
	Nonce            hexutil.Uint64  `json:"nonce"`
863
	To               *common.Address `json:"to"`
864 865 866 867 868
	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"`
869 870
}

871 872 873
// 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 {
874 875 876 877 878
	var signer types.Signer = types.FrontierSigner{}
	if tx.Protected() {
		signer = types.NewEIP155Signer(tx.ChainId())
	}
	from, _ := types.Sender(signer, tx)
879
	v, r, s := tx.RawSignatureValues()
880 881

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

902 903 904
// 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)
905 906
}

907 908 909 910 911
// 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
912
	}
913 914
	return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index)
}
915

916 917 918 919 920 921 922 923
// 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
924 925
}

926 927
// newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction {
928
	for idx, tx := range b.Transactions() {
929 930
		if tx.Hash() == hash {
			return newRPCTransactionFromBlockIndex(b, uint64(idx))
931 932
		}
	}
933
	return nil
934 935 936 937
}

// PublicTransactionPoolAPI exposes methods for the RPC interface
type PublicTransactionPoolAPI struct {
938 939
	b         Backend
	nonceLock *AddrLocker
940 941 942
}

// NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
943 944
func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI {
	return &PublicTransactionPoolAPI{b, nonceLock}
945 946 947
}

// GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
948
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
949
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
950 951
		n := hexutil.Uint(len(block.Transactions()))
		return &n
952 953 954 955 956
	}
	return nil
}

// GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
957
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
958
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
959 960
		n := hexutil.Uint(len(block.Transactions()))
		return &n
961 962 963 964 965
	}
	return nil
}

// GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
966
func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
967
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
968
		return newRPCTransactionFromBlockIndex(block, uint64(index))
969
	}
970
	return nil
971 972 973
}

// GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
974
func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
975
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
976
		return newRPCTransactionFromBlockIndex(block, uint64(index))
977
	}
978
	return nil
979 980
}

981
// GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
982
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
983
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
984
		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
985
	}
986
	return nil
987 988 989
}

// GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
990
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
991
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
992
		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
993
	}
994
	return nil
995 996
}

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

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

1021
// GetRawTransactionByHash returns the bytes of the transaction for the given hash.
1022
func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
1023 1024
	var tx *types.Transaction

1025
	// Retrieve a finalized transaction, or a pooled otherwise
1026
	if tx, _, _, _ = rawdb.ReadTransaction(s.b.ChainDb(), hash); tx == nil {
1027 1028 1029 1030
		if tx = s.b.GetPoolTransaction(hash); tx == nil {
			// Transaction not found anywhere, abort
			return nil, nil
		}
1031
	}
1032
	// Serialize to RLP and return
1033 1034 1035
	return rlp.EncodeToBytes(tx)
}

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

1051 1052 1053
	var signer types.Signer = types.FrontierSigner{}
	if tx.Protected() {
		signer = types.NewEIP155Signer(tx.ChainId())
1054
	}
1055
	from, _ := types.Sender(signer, tx)
1056 1057

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

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

// 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"`
1108
	Gas      *hexutil.Uint64 `json:"gas"`
1109 1110 1111
	GasPrice *hexutil.Big    `json:"gasPrice"`
	Value    *hexutil.Big    `json:"value"`
	Nonce    *hexutil.Uint64 `json:"nonce"`
1112 1113 1114 1115
	// 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"`
1116 1117
}

1118
// setDefaults is a helper function that fills in default values for unspecified tx fields.
1119
func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
1120
	if args.Gas == nil {
1121 1122
		args.Gas = new(hexutil.Uint64)
		*(*uint64)(args.Gas) = 90000
1123 1124 1125 1126
	}
	if args.GasPrice == nil {
		price, err := b.SuggestPrice(ctx)
		if err != nil {
1127
			return err
1128
		}
1129
		args.GasPrice = (*hexutil.Big)(price)
1130 1131
	}
	if args.Value == nil {
1132 1133 1134 1135 1136 1137 1138 1139 1140
		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)
	}
1141 1142 1143
	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.`)
	}
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
	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`)
		}
	}
1156 1157 1158 1159
	return nil
}

func (args *SendTxArgs) toTransaction() *types.Transaction {
1160 1161 1162 1163 1164 1165
	var input []byte
	if args.Data != nil {
		input = *args.Data
	} else if args.Input != nil {
		input = *args.Input
	}
1166
	if args.To == nil {
1167
		return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
1168
	}
1169
	return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
1170 1171
}

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

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

1195 1196 1197 1198 1199 1200 1201
	// 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
	}
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213

	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
	}
1214
	// Assemble the transaction and sign with the wallet
1215
	tx := args.toTransaction()
1216 1217 1218 1219 1220

	var chainID *big.Int
	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
		chainID = config.ChainId
	}
1221
	signed, err := wallet.SignTx(account, tx, chainID)
1222 1223 1224
	if err != nil {
		return common.Hash{}, err
	}
1225
	return submitTransaction(ctx, s.b, signed)
1226 1227 1228 1229
}

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

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

// SignTransactionResult represents a RLP encoded signed transaction.
type SignTransactionResult struct {
1265 1266
	Raw hexutil.Bytes      `json:"raw"`
	Tx  *types.Transaction `json:"tx"`
1267 1268 1269 1270 1271
}

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

// PendingTransactions returns the transactions that are in the transaction pool and have a from address that is one of
// the accounts this node manages.
1298 1299 1300 1301 1302 1303
func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return nil, err
	}

1304 1305
	transactions := make([]*RPCTransaction, 0, len(pending))
	for _, tx := range pending {
1306 1307 1308 1309 1310
		var signer types.Signer = types.HomesteadSigner{}
		if tx.Protected() {
			signer = types.NewEIP155Signer(tx.ChainId())
		}
		from, _ := types.Sender(signer, tx)
1311
		if _, err := s.b.AccountManager().Find(accounts.Account{Address: from}); err == nil {
1312 1313 1314
			transactions = append(transactions, newRPCPendingTransaction(tx))
		}
	}
1315
	return transactions, nil
1316 1317
}

1318 1319
// 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.
1320
func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {
1321 1322 1323 1324 1325 1326 1327
	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()
1328 1329 1330 1331 1332
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return common.Hash{}, err
	}

1333
	for _, p := range pending {
1334 1335 1336 1337
		var signer types.Signer = types.HomesteadSigner{}
		if p.Protected() {
			signer = types.NewEIP155Signer(p.ChainId())
		}
1338
		wantSigHash := signer.Hash(matchTx)
1339

1340 1341
		if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash {
			// Match. Re-sign and send the transaction.
1342
			if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 {
1343
				sendArgs.GasPrice = gasPrice
1344
			}
1345
			if gasLimit != nil && *gasLimit != 0 {
1346
				sendArgs.Gas = gasLimit
1347
			}
1348
			signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
			if err != nil {
				return common.Hash{}, err
			}
			if err = s.b.SendTx(ctx, signedTx); err != nil {
				return common.Hash{}, err
			}
			return signedTx.Hash(), nil
		}
	}

1359
	return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash())
1360 1361
}

1362
// PublicDebugAPI is the collection of Ethereum APIs exposed over the public
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392
// 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)
	}
1393
	return spew.Sdump(block), nil
1394 1395 1396 1397 1398 1399 1400 1401
}

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

1405
// PrivateDebugAPI is the collection of Ethereum APIs exposed over the private
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
// 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)
}

1433 1434 1435 1436 1437 1438 1439 1440
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++ {
1441
		log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
1442 1443
		err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}})
		if err != nil {
1444
			log.Error("Database compaction failed", "err", err)
1445 1446 1447 1448 1449 1450
			return err
		}
	}
	return nil
}

1451
// SetHead rewinds the head of the blockchain to a previous block.
1452 1453
func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
	api.b.SetHead(uint64(number))
1454 1455 1456 1457 1458
}

// PublicNetAPI offers network related RPC methods
type PublicNetAPI struct {
	net            *p2p.Server
1459
	networkVersion uint64
1460 1461 1462
}

// NewPublicNetAPI creates a new net API instance.
1463
func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
1464 1465 1466 1467 1468 1469 1470 1471 1472
	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
1473 1474
func (s *PublicNetAPI) PeerCount() hexutil.Uint {
	return hexutil.Uint(s.net.PeerCount())
1475 1476 1477 1478 1479 1480
}

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