api.go 55.8 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 = params.GWei
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 332 333
	if err != nil {
		log.Warn("Failed account unlock attempt", "address", addr, "err", err)
	}
334
	return err == nil, err
335 336 337 338
}

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

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

	var chainID *big.Int
	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
361
		chainID = config.ChainID
362
	}
363 364 365 366 367 368 369 370 371 372 373 374 375
	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)
	}
376
	signed, err := s.signTransaction(ctx, &args, passwd)
377
	if err != nil {
378
		log.Warn("Failed transaction send attempt", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err)
379 380
		return common.Hash{}, err
	}
381
	return SubmitTransaction(ctx, s.b, signed)
382 383
}

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
// 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")
	}
400
	signed, err := s.signTransaction(ctx, &args, passwd)
401
	if err != nil {
402
		log.Warn("Failed transaction sign attempt", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err)
403 404 405 406 407 408 409 410 411
		return nil, err
	}
	data, err := rlp.EncodeToBytes(signed)
	if err != nil {
		return nil, err
	}
	return &SignTransactionResult{data, signed}, nil
}

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

// 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)
//
457
// Note, the signature must conform to the secp256k1 curve R, S and V values, where
458
// the V value must be 27 or 28 for legacy reasons.
459
//
460
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover
461
func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {
462 463 464
	if len(sig) != 65 {
		return common.Address{}, fmt.Errorf("signature must be 65 bytes long")
	}
465 466
	if sig[64] != 27 && sig[64] != 28 {
		return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)")
467
	}
468
	sig[64] -= 27 // Transform yellow paper V from 27/28 to 0/1
469

470
	rpk, err := crypto.SigToPub(signHash(data), sig)
471 472 473
	if err != nil {
		return common.Address{}, err
	}
474
	return crypto.PubkeyToAddress(*rpk), nil
475 476
}

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

483 484 485
// 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 {
486
	b Backend
487 488
}

489
// NewPublicBlockChainAPI creates a new Ethereum blockchain API.
490
func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI {
491
	return &PublicBlockChainAPI{b}
492 493 494
}

// BlockNumber returns the block number of the chain head.
495
func (s *PublicBlockChainAPI) BlockNumber() hexutil.Uint64 {
496
	header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available
497
	return hexutil.Uint64(header.Number.Uint64())
498 499 500 501 502
}

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

511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
// Result structs for GetProof
type AccountResult struct {
	Address      common.Address  `json:"address"`
	AccountProof []string        `json:"accountProof"`
	Balance      *hexutil.Big    `json:"balance"`
	CodeHash     common.Hash     `json:"codeHash"`
	Nonce        hexutil.Uint64  `json:"nonce"`
	StorageHash  common.Hash     `json:"storageHash"`
	StorageProof []StorageResult `json:"storageProof"`
}
type StorageResult struct {
	Key   string       `json:"key"`
	Value *hexutil.Big `json:"value"`
	Proof []string     `json:"proof"`
}

// GetProof returns the Merkle-proof for a given account and optionally some storage keys.
func (s *PublicBlockChainAPI) GetProof(ctx context.Context, address common.Address, storageKeys []string, blockNr rpc.BlockNumber) (*AccountResult, error) {
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
	if state == nil || err != nil {
		return nil, err
	}

	storageTrie := state.StorageTrie(address)
	storageHash := types.EmptyRootHash
	codeHash := state.GetCodeHash(address)
	storageProof := make([]StorageResult, len(storageKeys))

	// if we have a storageTrie, (which means the account exists), we can update the storagehash
	if storageTrie != nil {
		storageHash = storageTrie.Hash()
	} else {
		// no storageTrie means the account does not exist, so the codeHash is the hash of an empty bytearray.
		codeHash = crypto.Keccak256Hash(nil)
	}

	// create the proof for the storageKeys
	for i, key := range storageKeys {
		if storageTrie != nil {
			proof, storageError := state.GetStorageProof(address, common.HexToHash(key))
			if storageError != nil {
				return nil, storageError
			}
			storageProof[i] = StorageResult{key, (*hexutil.Big)(state.GetState(address, common.HexToHash(key)).Big()), common.ToHexArray(proof)}
		} else {
			storageProof[i] = StorageResult{key, &hexutil.Big{}, []string{}}
		}
	}

	// create the accountProof
	accountProof, proofErr := state.GetProof(address)
	if proofErr != nil {
		return nil, proofErr
	}

	return &AccountResult{
		Address:      address,
		AccountProof: common.ToHexArray(accountProof),
		Balance:      (*hexutil.Big)(state.GetBalance(address)),
		CodeHash:     codeHash,
		Nonce:        hexutil.Uint64(state.GetNonce(address)),
		StorageHash:  storageHash,
		StorageProof: storageProof,
	}, state.Error()
}

577 578 579 580 581 582 583 584
// 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
585
			for _, field := range []string{"hash", "nonce", "miner"} {
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
				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.
606
func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {
607 608 609
	block, err := s.b.BlockByNumber(ctx, blockNr)
	if block != nil {
		uncles := block.Uncles()
610
		if index >= hexutil.Uint(len(uncles)) {
611
			log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index)
612 613
			return nil, nil
		}
614
		block = types.NewBlockWithHeader(uncles[index])
615 616 617 618 619 620 621
		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.
622
func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {
623 624 625
	block, err := s.b.GetBlock(ctx, blockHash)
	if block != nil {
		uncles := block.Uncles()
626
		if index >= hexutil.Uint(len(uncles)) {
627
			log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index)
628 629
			return nil, nil
		}
630
		block = types.NewBlockWithHeader(uncles[index])
631 632 633 634 635 636
		return s.rpcOutputBlock(block, false, false)
	}
	return nil, err
}

// GetUncleCountByBlockNumber returns number of uncles in the block for the given block number
637
func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
638
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
639 640
		n := hexutil.Uint(len(block.Uncles()))
		return &n
641 642 643 644 645
	}
	return nil
}

// GetUncleCountByBlockHash returns number of uncles in the block for the given block hash
646
func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
647
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
648 649
		n := hexutil.Uint(len(block.Uncles()))
		return &n
650 651 652 653 654
	}
	return nil
}

// GetCode returns the code stored at the given address in the state for the given block number.
655
func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
656
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
657
	if state == nil || err != nil {
658
		return nil, err
659
	}
660 661
	code := state.GetCode(address)
	return code, state.Error()
662 663 664 665 666
}

// 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.
667
func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
668
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
669
	if state == nil || err != nil {
670
		return nil, err
671
	}
672 673
	res := state.GetState(address, common.HexToHash(key))
	return res[:], state.Error()
674 675 676 677
}

// CallArgs represents the arguments for a call.
type CallArgs struct {
678
	From     *common.Address `json:"from"`
679
	To       *common.Address `json:"to"`
680 681 682 683
	Gas      *hexutil.Uint64 `json:"gas"`
	GasPrice *hexutil.Big    `json:"gasPrice"`
	Value    *hexutil.Big    `json:"value"`
	Data     *hexutil.Bytes  `json:"data"`
684 685
}

686
func DoCall(ctx context.Context, b Backend, args CallArgs, blockNr rpc.BlockNumber, vmCfg vm.Config, timeout time.Duration) ([]byte, uint64, bool, error) {
687
	defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now())
688

689
	state, header, err := b.StateAndHeaderByNumber(ctx, blockNr)
690
	if state == nil || err != nil {
691
		return nil, 0, false, err
692
	}
693
	// Set sender address or use a default if none specified
694 695 696
	var addr common.Address
	if args.From == nil {
		if wallets := b.AccountManager().Wallets(); len(wallets) > 0 {
697 698 699
			if accounts := wallets[0].Accounts(); len(accounts) > 0 {
				addr = accounts[0].Address
			}
700
		}
701 702
	} else {
		addr = *args.From
703
	}
704
	// Set default gas & gas price if none were set
705 706 707
	gas := uint64(math.MaxUint64 / 2)
	if args.Gas != nil {
		gas = uint64(*args.Gas)
708
	}
709 710 711 712 713 714 715 716 717 718 719 720 721
	gasPrice := new(big.Int).SetUint64(defaultGasPrice)
	if args.GasPrice != nil {
		gasPrice = args.GasPrice.ToInt()
	}

	value := new(big.Int)
	if args.Value != nil {
		value = args.Value.ToInt()
	}

	var data []byte
	if args.Data != nil {
		data = []byte(*args.Data)
722
	}
723 724

	// Create new call message
725
	msg := types.NewMessage(addr, args.To, 0, value, gas, gasPrice, data, false)
726

727 728 729
	// 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
730 731
	if timeout > 0 {
		ctx, cancel = context.WithTimeout(ctx, timeout)
732 733
	} else {
		ctx, cancel = context.WithCancel(ctx)
734
	}
735 736
	// Make sure the context is cancelled when the call has completed
	// this makes sure resources are cleaned up.
737
	defer cancel()
738 739

	// Get a new instance of the EVM.
740
	evm, vmError, err := b.GetEVM(ctx, msg, state, header)
741
	if err != nil {
742
		return nil, 0, false, err
743 744 745 746
	}
	// Wait for the context to be done and cancel the evm. Even if the
	// EVM has finished, cancelling may be done (repeatedly)
	go func() {
747 748
		<-ctx.Done()
		evm.Cancel()
749 750 751 752
	}()

	// Setup the gas pool (also for unmetered requests)
	// and apply the message.
753
	gp := new(core.GasPool).AddGas(math.MaxUint64)
754
	res, gas, failed, err := core.ApplyMessage(evm, msg, gp)
755
	if err := vmError(); err != nil {
756
		return nil, 0, false, err
757
	}
758
	return res, gas, failed, err
759 760 761
}

// Call executes the given transaction on the state for the given block number.
762
// It doesn't make and changes in the state/blockchain and is useful to execute and retrieve values.
763
func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
764
	result, _, _, err := DoCall(ctx, s.b, args, blockNr, vm.Config{}, 5*time.Second)
765
	return (hexutil.Bytes)(result), err
766 767
}

768
func DoEstimateGas(ctx context.Context, b Backend, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Uint64, error) {
769
	// Binary search the gas requirement, as it may be higher than the amount used
770
	var (
771 772 773
		lo  uint64 = params.TxGas - 1
		hi  uint64
		cap uint64
774
	)
775 776
	if args.Gas != nil && uint64(*args.Gas) >= params.TxGas {
		hi = uint64(*args.Gas)
777
	} else {
778 779
		// Retrieve the block to act as the gas ceiling
		block, err := b.BlockByNumber(ctx, blockNr)
780
		if err != nil {
781
			return 0, err
782
		}
783
		hi = block.GasLimit()
784
	}
785
	cap = hi
786

787 788
	// Create a helper to check if a gas allowance results in an executable transaction
	executable := func(gas uint64) bool {
789
		args.Gas = (*hexutil.Uint64)(&gas)
790

791
		_, _, failed, err := DoCall(ctx, b, args, rpc.PendingBlockNumber, vm.Config{}, 0)
792
		if err != nil || failed {
793 794 795 796 797 798 799 800
			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) {
801
			lo = mid
802 803 804 805 806 807 808
		} else {
			hi = mid
		}
	}
	// Reject the transaction as invalid if it still fails at the highest allowance
	if hi == cap {
		if !executable(hi) {
809
			return 0, fmt.Errorf("gas required exceeds allowance or always failing transaction")
810 811
		}
	}
812
	return hexutil.Uint64(hi), nil
813 814
}

815 816 817 818 819 820
// EstimateGas returns an estimate of the amount of gas needed to execute the
// given transaction against the current pending block.
func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (hexutil.Uint64, error) {
	return DoEstimateGas(ctx, s.b, args, rpc.PendingBlockNumber)
}

821
// ExecutionResult groups all structured logs emitted by the EVM
822 823
// while replaying a transaction in debug mode as well as transaction
// execution status, the amount of gas used and the return value
824
type ExecutionResult struct {
825
	Gas         uint64         `json:"gas"`
826
	Failed      bool           `json:"failed"`
827 828 829 830 831 832 833
	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 {
834 835 836 837 838 839 840 841 842
	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"`
843 844
}

845
// FormatLogs formats EVM returned structured logs for json output
846 847 848 849
func FormatLogs(logs []vm.StructLog) []StructLogRes {
	formatted := make([]StructLogRes, len(logs))
	for index, trace := range logs {
		formatted[index] = StructLogRes{
850 851 852 853 854 855 856
			Pc:      trace.Pc,
			Op:      trace.Op.String(),
			Gas:     trace.Gas,
			GasCost: trace.GasCost,
			Depth:   trace.Depth,
			Error:   trace.Err,
		}
857 858 859 860 861 862
		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
863
		}
864 865 866 867 868 869
		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
870
		}
871 872 873 874 875 876
		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
877 878
		}
	}
879
	return formatted
880 881
}

882
// RPCMarshalBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are
883 884
// returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain
// transaction hashes.
885
func RPCMarshalBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
886
	head := b.Header() // copies the header once
887
	fields := map[string]interface{}{
888
		"number":           (*hexutil.Big)(head.Number),
889
		"hash":             b.Hash(),
890 891 892 893 894 895 896
		"parentHash":       head.ParentHash,
		"nonce":            head.Nonce,
		"mixHash":          head.MixDigest,
		"sha3Uncles":       head.UncleHash,
		"logsBloom":        head.Bloom,
		"stateRoot":        head.Root,
		"miner":            head.Coinbase,
897
		"difficulty":       (*hexutil.Big)(head.Difficulty),
898
		"extraData":        hexutil.Bytes(head.Extra),
899
		"size":             hexutil.Uint64(b.Size()),
900 901
		"gasLimit":         hexutil.Uint64(head.GasLimit),
		"gasUsed":          hexutil.Uint64(head.GasUsed),
902
		"timestamp":        (*hexutil.Big)(head.Time),
903
		"transactionsRoot": head.TxHash,
904
		"receiptsRoot":     head.ReceiptHash,
905 906 907 908 909 910 911 912
	}

	if inclTx {
		formatTx := func(tx *types.Transaction) (interface{}, error) {
			return tx.Hash(), nil
		}
		if fullTx {
			formatTx = func(tx *types.Transaction) (interface{}, error) {
913
				return newRPCTransactionFromBlockHash(b, tx.Hash()), nil
914 915 916 917 918
			}
		}
		txs := b.Transactions()
		transactions := make([]interface{}, len(txs))
		var err error
919
		for i, tx := range txs {
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936
			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
}

937 938 939 940 941 942 943 944 945 946 947
// 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
}

948 949 950
// RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction
type RPCTransaction struct {
	BlockHash        common.Hash     `json:"blockHash"`
951
	BlockNumber      *hexutil.Big    `json:"blockNumber"`
952
	From             common.Address  `json:"from"`
953
	Gas              hexutil.Uint64  `json:"gas"`
954
	GasPrice         *hexutil.Big    `json:"gasPrice"`
955
	Hash             common.Hash     `json:"hash"`
956
	Input            hexutil.Bytes   `json:"input"`
957
	Nonce            hexutil.Uint64  `json:"nonce"`
958
	To               *common.Address `json:"to"`
959 960 961 962 963
	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"`
964 965
}

966 967 968
// 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 {
969 970 971 972 973
	var signer types.Signer = types.FrontierSigner{}
	if tx.Protected() {
		signer = types.NewEIP155Signer(tx.ChainId())
	}
	from, _ := types.Sender(signer, tx)
974
	v, r, s := tx.RawSignatureValues()
975 976

	result := &RPCTransaction{
977
		From:     from,
978
		Gas:      hexutil.Uint64(tx.Gas()),
979
		GasPrice: (*hexutil.Big)(tx.GasPrice()),
980
		Hash:     tx.Hash(),
981
		Input:    hexutil.Bytes(tx.Data()),
982
		Nonce:    hexutil.Uint64(tx.Nonce()),
983
		To:       tx.To(),
984 985 986 987
		Value:    (*hexutil.Big)(tx.Value()),
		V:        (*hexutil.Big)(v),
		R:        (*hexutil.Big)(r),
		S:        (*hexutil.Big)(s),
988
	}
989 990 991 992 993 994
	if blockHash != (common.Hash{}) {
		result.BlockHash = blockHash
		result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber))
		result.TransactionIndex = hexutil.Uint(index)
	}
	return result
995 996
}

997 998 999
// 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)
1000 1001
}

1002 1003 1004 1005 1006
// 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
1007
	}
1008 1009
	return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index)
}
1010

1011 1012 1013 1014 1015 1016 1017 1018
// 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
1019 1020
}

1021 1022
// newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction {
1023
	for idx, tx := range b.Transactions() {
1024 1025
		if tx.Hash() == hash {
			return newRPCTransactionFromBlockIndex(b, uint64(idx))
1026 1027
		}
	}
1028
	return nil
1029 1030 1031 1032
}

// PublicTransactionPoolAPI exposes methods for the RPC interface
type PublicTransactionPoolAPI struct {
1033 1034
	b         Backend
	nonceLock *AddrLocker
1035 1036 1037
}

// NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
1038 1039
func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI {
	return &PublicTransactionPoolAPI{b, nonceLock}
1040 1041 1042
}

// GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
1043
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
1044
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
1045 1046
		n := hexutil.Uint(len(block.Transactions()))
		return &n
1047 1048 1049 1050 1051
	}
	return nil
}

// GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
1052
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
1053
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
1054 1055
		n := hexutil.Uint(len(block.Transactions()))
		return &n
1056 1057 1058 1059 1060
	}
	return nil
}

// GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
1061
func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
1062
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
1063
		return newRPCTransactionFromBlockIndex(block, uint64(index))
1064
	}
1065
	return nil
1066 1067 1068
}

// GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
1069
func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
1070
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
1071
		return newRPCTransactionFromBlockIndex(block, uint64(index))
1072
	}
1073
	return nil
1074 1075
}

1076
// GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
1077
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
1078
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
1079
		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
1080
	}
1081
	return nil
1082 1083 1084
}

// GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
1085
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
1086
	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
1087
		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
1088
	}
1089
	return nil
1090 1091
}

1092
// GetTransactionCount returns the number of transactions the given address has sent for the given block number
1093
func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) {
1094 1095 1096 1097 1098 1099 1100 1101 1102
	// Ask transaction pool for the nonce which includes pending transactions
	if blockNr == rpc.PendingBlockNumber {
		nonce, err := s.b.GetPoolNonce(ctx, address)
		if err != nil {
			return nil, err
		}
		return (*hexutil.Uint64)(&nonce), nil
	}
	// Resolve block number and use its state to ask for the nonce
1103
	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
1104 1105 1106
	if state == nil || err != nil {
		return nil, err
	}
1107 1108
	nonce := state.GetNonce(address)
	return (*hexutil.Uint64)(&nonce), state.Error()
1109 1110 1111
}

// GetTransactionByHash returns the transaction for the given hash
1112 1113
func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) *RPCTransaction {
	// Try to return an already finalized transaction
1114
	if tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash); tx != nil {
1115
		return newRPCTransaction(tx, blockHash, blockNumber, index)
1116
	}
1117 1118 1119
	// No finalized transaction, try to retrieve it from the pool
	if tx := s.b.GetPoolTransaction(hash); tx != nil {
		return newRPCPendingTransaction(tx)
1120
	}
1121 1122
	// Transaction unknown, return as such
	return nil
1123 1124
}

1125
// GetRawTransactionByHash returns the bytes of the transaction for the given hash.
1126
func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
1127 1128
	var tx *types.Transaction

1129
	// Retrieve a finalized transaction, or a pooled otherwise
1130
	if tx, _, _, _ = rawdb.ReadTransaction(s.b.ChainDb(), hash); tx == nil {
1131 1132 1133 1134
		if tx = s.b.GetPoolTransaction(hash); tx == nil {
			// Transaction not found anywhere, abort
			return nil, nil
		}
1135
	}
1136
	// Serialize to RLP and return
1137 1138 1139
	return rlp.EncodeToBytes(tx)
}

1140
// GetTransactionReceipt returns the transaction receipt for the given transaction hash.
1141
func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {
1142
	tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash)
1143
	if tx == nil {
1144
		return nil, nil
1145
	}
1146 1147 1148 1149 1150
	receipts, err := s.b.GetReceipts(ctx, blockHash)
	if err != nil {
		return nil, err
	}
	if len(receipts) <= int(index) {
1151
		return nil, nil
1152
	}
1153
	receipt := receipts[index]
1154

1155 1156 1157
	var signer types.Signer = types.FrontierSigner{}
	if tx.Protected() {
		signer = types.NewEIP155Signer(tx.ChainId())
1158
	}
1159
	from, _ := types.Sender(signer, tx)
1160 1161

	fields := map[string]interface{}{
1162 1163
		"blockHash":         blockHash,
		"blockNumber":       hexutil.Uint64(blockNumber),
1164
		"transactionHash":   hash,
1165
		"transactionIndex":  hexutil.Uint64(index),
1166 1167
		"from":              from,
		"to":                tx.To(),
1168 1169
		"gasUsed":           hexutil.Uint64(receipt.GasUsed),
		"cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed),
1170 1171
		"contractAddress":   nil,
		"logs":              receipt.Logs,
1172
		"logsBloom":         receipt.Bloom,
1173
	}
1174 1175 1176 1177 1178

	// Assign receipt status or post state.
	if len(receipt.PostState) > 0 {
		fields["root"] = hexutil.Bytes(receipt.PostState)
	} else {
1179
		fields["status"] = hexutil.Uint(receipt.Status)
1180
	}
1181
	if receipt.Logs == nil {
1182
		fields["logs"] = [][]*types.Log{}
1183 1184
	}
	// If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
1185
	if receipt.ContractAddress != (common.Address{}) {
1186 1187 1188 1189 1190 1191 1192
		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) {
1193 1194 1195 1196 1197 1198 1199 1200
	// 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
1201 1202
	var chainID *big.Int
	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
1203
		chainID = config.ChainID
1204
	}
1205
	return wallet.SignTx(account, tx, chainID)
1206 1207 1208 1209 1210 1211
}

// 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"`
1212
	Gas      *hexutil.Uint64 `json:"gas"`
1213 1214 1215
	GasPrice *hexutil.Big    `json:"gasPrice"`
	Value    *hexutil.Big    `json:"value"`
	Nonce    *hexutil.Uint64 `json:"nonce"`
1216 1217 1218 1219
	// 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"`
1220 1221
}

1222
// setDefaults is a helper function that fills in default values for unspecified tx fields.
1223
func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
1224
	if args.Gas == nil {
1225 1226
		args.Gas = new(hexutil.Uint64)
		*(*uint64)(args.Gas) = 90000
1227 1228 1229 1230
	}
	if args.GasPrice == nil {
		price, err := b.SuggestPrice(ctx)
		if err != nil {
1231
			return err
1232
		}
1233
		args.GasPrice = (*hexutil.Big)(price)
1234 1235
	}
	if args.Value == nil {
1236 1237 1238 1239 1240 1241 1242 1243 1244
		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)
	}
1245 1246 1247
	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.`)
	}
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
	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`)
		}
	}
1260 1261 1262 1263
	return nil
}

func (args *SendTxArgs) toTransaction() *types.Transaction {
1264 1265 1266 1267 1268 1269
	var input []byte
	if args.Data != nil {
		input = *args.Data
	} else if args.Input != nil {
		input = *args.Input
	}
1270
	if args.To == nil {
1271
		return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
1272
	}
1273
	return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
1274 1275
}

1276 1277
// SubmitTransaction is a helper function that submits tx to txPool and logs a message.
func SubmitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) {
1278
	if err := b.SendTx(ctx, tx); err != nil {
1279 1280
		return common.Hash{}, err
	}
1281 1282
	if tx.To() == nil {
		signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
1283 1284 1285 1286
		from, err := types.Sender(signer, tx)
		if err != nil {
			return common.Hash{}, err
		}
1287
		addr := crypto.CreateAddress(from, tx.Nonce())
1288
		log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
1289
	} else {
1290
		log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
1291
	}
1292
	return tx.Hash(), nil
1293 1294 1295 1296 1297
}

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

1299 1300 1301 1302 1303 1304 1305
	// 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
	}
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317

	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
	}
1318
	// Assemble the transaction and sign with the wallet
1319
	tx := args.toTransaction()
1320 1321 1322

	var chainID *big.Int
	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
1323
		chainID = config.ChainID
1324
	}
1325
	signed, err := wallet.SignTx(account, tx, chainID)
1326 1327 1328
	if err != nil {
		return common.Hash{}, err
	}
1329
	return SubmitTransaction(ctx, s.b, signed)
1330 1331 1332 1333
}

// SendRawTransaction will add the signed transaction to the transaction pool.
// The sender is responsible for signing the transaction and using the correct nonce.
1334
func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) {
1335
	tx := new(types.Transaction)
1336
	if err := rlp.DecodeBytes(encodedTx, tx); err != nil {
1337
		return common.Hash{}, err
1338
	}
1339
	return SubmitTransaction(ctx, s.b, tx)
1340 1341
}

1342 1343 1344
// Sign calculates an ECDSA signature for:
// keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
//
1345 1346 1347
// 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.
//
1348 1349 1350
// The account associated with addr must be unlocked.
//
// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
1351
func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
1352 1353 1354 1355 1356 1357 1358 1359 1360
	// 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))
1361
	if err == nil {
1362
		signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
1363 1364
	}
	return signature, err
1365 1366 1367 1368
}

// SignTransactionResult represents a RLP encoded signed transaction.
type SignTransactionResult struct {
1369 1370
	Raw hexutil.Bytes      `json:"raw"`
	Tx  *types.Transaction `json:"tx"`
1371 1372 1373 1374 1375
}

// 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.
1376
func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
1377 1378 1379 1380 1381 1382
	if args.Gas == nil {
		return nil, fmt.Errorf("gas not specified")
	}
	if args.GasPrice == nil {
		return nil, fmt.Errorf("gasPrice not specified")
	}
1383
	if args.Nonce == nil {
1384
		return nil, fmt.Errorf("nonce not specified")
1385
	}
1386 1387
	if err := args.setDefaults(ctx, s.b); err != nil {
		return nil, err
1388
	}
1389
	tx, err := s.sign(args.From, args.toTransaction())
1390 1391 1392
	if err != nil {
		return nil, err
	}
1393
	data, err := rlp.EncodeToBytes(tx)
1394 1395 1396
	if err != nil {
		return nil, err
	}
1397
	return &SignTransactionResult{data, tx}, nil
1398 1399
}

1400 1401
// PendingTransactions returns the transactions that are in the transaction pool
// and have a from address that is one of the accounts this node manages.
1402 1403 1404 1405 1406
func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return nil, err
	}
1407 1408 1409 1410 1411 1412
	accounts := make(map[common.Address]struct{})
	for _, wallet := range s.b.AccountManager().Wallets() {
		for _, account := range wallet.Accounts() {
			accounts[account.Address] = struct{}{}
		}
	}
1413 1414
	transactions := make([]*RPCTransaction, 0, len(pending))
	for _, tx := range pending {
1415 1416 1417 1418 1419
		var signer types.Signer = types.HomesteadSigner{}
		if tx.Protected() {
			signer = types.NewEIP155Signer(tx.ChainId())
		}
		from, _ := types.Sender(signer, tx)
1420
		if _, exists := accounts[from]; exists {
1421 1422 1423
			transactions = append(transactions, newRPCPendingTransaction(tx))
		}
	}
1424
	return transactions, nil
1425 1426
}

1427 1428
// 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.
1429
func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {
1430 1431 1432 1433 1434 1435 1436
	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()
1437 1438 1439 1440 1441
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return common.Hash{}, err
	}

1442
	for _, p := range pending {
1443 1444 1445 1446
		var signer types.Signer = types.HomesteadSigner{}
		if p.Protected() {
			signer = types.NewEIP155Signer(p.ChainId())
		}
1447
		wantSigHash := signer.Hash(matchTx)
1448

1449 1450
		if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash {
			// Match. Re-sign and send the transaction.
1451
			if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 {
1452
				sendArgs.GasPrice = gasPrice
1453
			}
1454
			if gasLimit != nil && *gasLimit != 0 {
1455
				sendArgs.Gas = gasLimit
1456
			}
1457
			signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())
1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
			if err != nil {
				return common.Hash{}, err
			}
			if err = s.b.SendTx(ctx, signedTx); err != nil {
				return common.Hash{}, err
			}
			return signedTx.Hash(), nil
		}
	}

1468
	return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash())
1469 1470
}

1471
// PublicDebugAPI is the collection of Ethereum APIs exposed over the public
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
// 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)
	}
1502
	return spew.Sdump(block), nil
1503 1504 1505 1506 1507 1508 1509 1510
}

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

1514
// PrivateDebugAPI is the collection of Ethereum APIs exposed over the private
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
// 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)
}

1542 1543 1544 1545 1546 1547 1548 1549
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++ {
1550
		log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
1551 1552
		err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}})
		if err != nil {
1553
			log.Error("Database compaction failed", "err", err)
1554 1555 1556 1557 1558 1559
			return err
		}
	}
	return nil
}

1560
// SetHead rewinds the head of the blockchain to a previous block.
1561 1562
func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
	api.b.SetHead(uint64(number))
1563 1564 1565 1566 1567
}

// PublicNetAPI offers network related RPC methods
type PublicNetAPI struct {
	net            *p2p.Server
1568
	networkVersion uint64
1569 1570 1571
}

// NewPublicNetAPI creates a new net API instance.
1572
func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
1573 1574 1575 1576 1577 1578 1579 1580 1581
	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
1582 1583
func (s *PublicNetAPI) PeerCount() hexutil.Uint {
	return hexutil.Uint(s.net.PeerCount())
1584 1585 1586 1587 1588 1589
}

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