api.go 63.5 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/accounts/scwallet"
32
	"github.com/ethereum/go-ethereum/common"
33
	"github.com/ethereum/go-ethereum/common/hexutil"
34
	"github.com/ethereum/go-ethereum/common/math"
35
	"github.com/ethereum/go-ethereum/consensus/clique"
36
	"github.com/ethereum/go-ethereum/consensus/ethash"
37
	"github.com/ethereum/go-ethereum/core"
38
	"github.com/ethereum/go-ethereum/core/rawdb"
39 40 41
	"github.com/ethereum/go-ethereum/core/types"
	"github.com/ethereum/go-ethereum/core/vm"
	"github.com/ethereum/go-ethereum/crypto"
42
	"github.com/ethereum/go-ethereum/log"
43
	"github.com/ethereum/go-ethereum/p2p"
44
	"github.com/ethereum/go-ethereum/params"
45 46
	"github.com/ethereum/go-ethereum/rlp"
	"github.com/ethereum/go-ethereum/rpc"
47
	"github.com/tyler-smith/go-bip39"
48 49
)

50
const (
51
	defaultGasPrice = params.GWei
52
)
53

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

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

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

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

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

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

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

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

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

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

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

215
// listAccounts will return a list of addresses for accounts this node manages.
216
func (s *PrivateAccountAPI) ListAccounts() []common.Address {
217
	return s.am.Accounts()
218 219
}

220 221 222 223 224
// 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"`
225 226
	Failure  string             `json:"failure,omitempty"`
	Accounts []accounts.Account `json:"accounts,omitempty"`
227 228 229 230
}

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

		raw := rawWallet{
236
			URL:      wallet.URL().String(),
237
			Status:   status,
238
			Accounts: wallet.Accounts(),
239 240 241 242 243
		}
		if failure != nil {
			raw.Failure = failure.Error()
		}
		wallets = append(wallets, raw)
244 245 246 247
	}
	return wallets
}

248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
// 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)
}

264 265 266 267 268 269 270
// 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
	}
271 272 273 274
	derivPath, err := accounts.ParseDerivationPath(path)
	if err != nil {
		return accounts.Account{}, err
	}
275 276 277
	if pin == nil {
		pin = new(bool)
	}
278
	return wallet.Derive(derivPath, *pin)
279 280
}

281 282
// NewAccount will create a new account and returns the address for the new account.
func (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) {
283
	acc, err := fetchKeystore(s.am).NewAccount(password)
284
	if err == nil {
285 286 287
		log.Info("Your new key was generated", "address", acc.Address)
		log.Warn("Please backup your key file!", "path", acc.URL.Path)
		log.Warn("Please remember your password!")
288 289 290 291 292
		return acc.Address, nil
	}
	return common.Address{}, err
}

293 294
// fetchKeystore retrives the encrypted keystore from the account manager.
func fetchKeystore(am *accounts.Manager) *keystore.KeyStore {
295
	return am.Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
296 297
}

298 299 300
// 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) {
301
	key, err := crypto.HexToECDSA(privkey)
302 303 304
	if err != nil {
		return common.Address{}, err
	}
305
	acc, err := fetchKeystore(s.am).ImportECDSA(key, password)
306 307 308 309 310 311
	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.
312 313 314 315 316 317 318 319
func (s *PrivateAccountAPI) UnlockAccount(ctx context.Context, addr common.Address, password string, duration *uint64) (bool, error) {
	// When the API is exposed by external RPC(http, ws etc), unless the user
	// explicitly specifies to allow the insecure account unlocking, otherwise
	// it is disabled.
	if s.b.ExtRPCEnabled() && !s.b.AccountManager().Config().InsecureUnlockAllowed {
		return false, errors.New("account unlock with HTTP access is forbidden")
	}

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

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

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

358
	return wallet.SignTxWithPassphrase(account, passwd, tx, s.b.ChainConfig().ChainID)
359 360 361 362 363 364 365 366 367 368 369 370
}

// 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)
	}
371
	signed, err := s.signTransaction(ctx, &args, passwd)
372
	if err != nil {
373
		log.Warn("Failed transaction send attempt", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err)
374 375
		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
// 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")
	}
395
	signed, err := s.signTransaction(ctx, &args, passwd)
396
	if err != nil {
397
		log.Warn("Failed transaction sign attempt", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err)
398 399 400 401 402 403 404 405 406
		return nil, err
	}
	data, err := rlp.EncodeToBytes(signed)
	if err != nil {
		return nil, err
	}
	return &SignTransactionResult{data, signed}, nil
}

407 408 409
// Sign calculates an Ethereum ECDSA signature for:
// keccack256("\x19Ethereum Signed Message:\n" + len(message) + message))
//
410 411 412
// 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.
//
413 414 415
// The key used to calculate the signature is decrypted with the given password.
//
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign
416
func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {
417 418 419 420 421 422 423 424
	// 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
425
	signature, err := wallet.SignTextWithPassphrase(account, passwd, data)
426
	if err != nil {
427
		log.Warn("Failed data sign attempt", "address", addr, "err", err)
428 429
		return nil, err
	}
430
	signature[crypto.RecoveryIDOffset] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
431
	return signature, nil
432 433 434 435 436 437 438 439
}

// 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)
//
440
// Note, the signature must conform to the secp256k1 curve R, S and V values, where
441
// the V value must be 27 or 28 for legacy reasons.
442
//
443
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover
444
func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {
445 446
	if len(sig) != crypto.SignatureLength {
		return common.Address{}, fmt.Errorf("signature must be %d bytes long", crypto.SignatureLength)
447
	}
448
	if sig[crypto.RecoveryIDOffset] != 27 && sig[crypto.RecoveryIDOffset] != 28 {
449
		return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)")
450
	}
451
	sig[crypto.RecoveryIDOffset] -= 27 // Transform yellow paper V from 27/28 to 0/1
452

453
	rpk, err := crypto.SigToPub(accounts.TextHash(data), sig)
454 455 456
	if err != nil {
		return common.Address{}, err
	}
457
	return crypto.PubkeyToAddress(*rpk), nil
458 459
}

460 461 462 463 464 465
// 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)
}

466
// InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key.
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
func (s *PrivateAccountAPI) InitializeWallet(ctx context.Context, url string) (string, error) {
	wallet, err := s.am.Wallet(url)
	if err != nil {
		return "", err
	}

	entropy, err := bip39.NewEntropy(256)
	if err != nil {
		return "", err
	}

	mnemonic, err := bip39.NewMnemonic(entropy)
	if err != nil {
		return "", err
	}

	seed := bip39.NewSeed(mnemonic, "")

	switch wallet := wallet.(type) {
	case *scwallet.Wallet:
		return mnemonic, wallet.Initialize(seed)
	default:
489
		return "", fmt.Errorf("specified wallet does not support initialization")
490 491 492
	}
}

493
// Unpair deletes a pairing between wallet and geth.
494 495 496 497 498 499 500 501 502 503
func (s *PrivateAccountAPI) Unpair(ctx context.Context, url string, pin string) error {
	wallet, err := s.am.Wallet(url)
	if err != nil {
		return err
	}

	switch wallet := wallet.(type) {
	case *scwallet.Wallet:
		return wallet.Unpair([]byte(pin))
	default:
504
		return fmt.Errorf("specified wallet does not support pairing")
505 506 507
	}
}

508 509 510
// 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 {
511
	b Backend
512 513
}

514
// NewPublicBlockChainAPI creates a new Ethereum blockchain API.
515
func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI {
516
	return &PublicBlockChainAPI{b}
517 518
}

519 520 521 522 523
// ChainId returns the chainID value for transaction replay protection.
func (s *PublicBlockChainAPI) ChainId() *hexutil.Big {
	return (*hexutil.Big)(s.b.ChainConfig().ChainID)
}

524
// BlockNumber returns the block number of the chain head.
525
func (s *PublicBlockChainAPI) BlockNumber() hexutil.Uint64 {
526
	header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available
527
	return hexutil.Uint64(header.Number.Uint64())
528 529 530 531 532
}

// 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.
533 534
func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (*hexutil.Big, error) {
	state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
535 536 537
	if state == nil || err != nil {
		return nil, err
	}
538
	return (*hexutil.Big)(state.GetBalance(address)), state.Error()
539 540
}

541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
// 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.
558 559
func (s *PublicBlockChainAPI) GetProof(ctx context.Context, address common.Address, storageKeys []string, blockNrOrHash rpc.BlockNumberOrHash) (*AccountResult, error) {
	state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
	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()
}

607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
// GetHeaderByNumber returns the requested canonical block header.
// * When blockNr is -1 the chain head is returned.
// * When blockNr is -2 the pending chain head is returned.
func (s *PublicBlockChainAPI) GetHeaderByNumber(ctx context.Context, number rpc.BlockNumber) (map[string]interface{}, error) {
	header, err := s.b.HeaderByNumber(ctx, number)
	if header != nil && err == nil {
		response := s.rpcMarshalHeader(header)
		if number == rpc.PendingBlockNumber {
			// Pending header need to nil out a few fields
			for _, field := range []string{"hash", "nonce", "miner"} {
				response[field] = nil
			}
		}
		return response, err
	}
	return nil, err
}

// GetHeaderByHash returns the requested header by hash.
func (s *PublicBlockChainAPI) GetHeaderByHash(ctx context.Context, hash common.Hash) map[string]interface{} {
627
	header, _ := s.b.HeaderByHash(ctx, hash)
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
	if header != nil {
		return s.rpcMarshalHeader(header)
	}
	return nil
}

// GetBlockByNumber returns the requested canonical block.
// * When blockNr is -1 the chain head is returned.
// * When blockNr is -2 the pending chain head is returned.
// * When fullTx is true all transactions in the block are returned, otherwise
//   only the transaction hash is returned.
func (s *PublicBlockChainAPI) GetBlockByNumber(ctx context.Context, number rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) {
	block, err := s.b.BlockByNumber(ctx, number)
	if block != nil && err == nil {
		response, err := s.rpcMarshalBlock(block, true, fullTx)
		if err == nil && number == rpc.PendingBlockNumber {
644
			// Pending blocks need to nil out a few fields
645
			for _, field := range []string{"hash", "nonce", "miner"} {
646 647 648 649 650 651 652 653 654 655
				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.
656
func (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, hash common.Hash, fullTx bool) (map[string]interface{}, error) {
657
	block, err := s.b.BlockByHash(ctx, hash)
658
	if block != nil {
659
		return s.rpcMarshalBlock(block, true, fullTx)
660 661 662 663 664 665
	}
	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.
666
func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {
667 668 669
	block, err := s.b.BlockByNumber(ctx, blockNr)
	if block != nil {
		uncles := block.Uncles()
670
		if index >= hexutil.Uint(len(uncles)) {
671
			log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index)
672 673
			return nil, nil
		}
674
		block = types.NewBlockWithHeader(uncles[index])
675
		return s.rpcMarshalBlock(block, false, false)
676 677 678 679 680 681
	}
	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.
682
func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {
683
	block, err := s.b.BlockByHash(ctx, blockHash)
684 685
	if block != nil {
		uncles := block.Uncles()
686
		if index >= hexutil.Uint(len(uncles)) {
687
			log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index)
688 689
			return nil, nil
		}
690
		block = types.NewBlockWithHeader(uncles[index])
691
		return s.rpcMarshalBlock(block, false, false)
692 693 694 695 696
	}
	return nil, err
}

// GetUncleCountByBlockNumber returns number of uncles in the block for the given block number
697
func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
698
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
699 700
		n := hexutil.Uint(len(block.Uncles()))
		return &n
701 702 703 704 705
	}
	return nil
}

// GetUncleCountByBlockHash returns number of uncles in the block for the given block hash
706
func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
707
	if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
708 709
		n := hexutil.Uint(len(block.Uncles()))
		return &n
710 711 712 713 714
	}
	return nil
}

// GetCode returns the code stored at the given address in the state for the given block number.
715 716
func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (hexutil.Bytes, error) {
	state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
717
	if state == nil || err != nil {
718
		return nil, err
719
	}
720 721
	code := state.GetCode(address)
	return code, state.Error()
722 723 724 725 726
}

// 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.
727 728
func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNrOrHash rpc.BlockNumberOrHash) (hexutil.Bytes, error) {
	state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
729
	if state == nil || err != nil {
730
		return nil, err
731
	}
732 733
	res := state.GetState(address, common.HexToHash(key))
	return res[:], state.Error()
734 735 736 737
}

// CallArgs represents the arguments for a call.
type CallArgs struct {
738
	From     *common.Address `json:"from"`
739
	To       *common.Address `json:"to"`
740 741 742 743
	Gas      *hexutil.Uint64 `json:"gas"`
	GasPrice *hexutil.Big    `json:"gasPrice"`
	Value    *hexutil.Big    `json:"value"`
	Data     *hexutil.Bytes  `json:"data"`
744 745
}

746 747 748 749 750 751 752 753 754 755 756 757 758 759
// account indicates the overriding fields of account during the execution of
// a message call.
// Note, state and stateDiff can't be specified at the same time. If state is
// set, message execution will only use the data in the given state. Otherwise
// if statDiff is set, all diff will be applied first and then execute the call
// message.
type account struct {
	Nonce     *hexutil.Uint64              `json:"nonce"`
	Code      *hexutil.Bytes               `json:"code"`
	Balance   **hexutil.Big                `json:"balance"`
	State     *map[common.Hash]common.Hash `json:"state"`
	StateDiff *map[common.Hash]common.Hash `json:"stateDiff"`
}

760
func DoCall(ctx context.Context, b Backend, args CallArgs, blockNrOrHash rpc.BlockNumberOrHash, overrides map[common.Address]account, vmCfg vm.Config, timeout time.Duration, globalGasCap *big.Int) ([]byte, uint64, bool, error) {
761
	defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now())
762

763
	state, header, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
764
	if state == nil || err != nil {
765
		return nil, 0, false, err
766
	}
767
	// Set sender address or use a default if none specified
768 769 770
	var addr common.Address
	if args.From == nil {
		if wallets := b.AccountManager().Wallets(); len(wallets) > 0 {
771 772 773
			if accounts := wallets[0].Accounts(); len(accounts) > 0 {
				addr = accounts[0].Address
			}
774
		}
775 776
	} else {
		addr = *args.From
777
	}
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
	// Override the fields of specified contracts before execution.
	for addr, account := range overrides {
		// Override account nonce.
		if account.Nonce != nil {
			state.SetNonce(addr, uint64(*account.Nonce))
		}
		// Override account(contract) code.
		if account.Code != nil {
			state.SetCode(addr, *account.Code)
		}
		// Override account balance.
		if account.Balance != nil {
			state.SetBalance(addr, (*big.Int)(*account.Balance))
		}
		if account.State != nil && account.StateDiff != nil {
			return nil, 0, false, fmt.Errorf("account %s has both 'state' and 'stateDiff'", addr.Hex())
		}
		// Replace entire state if caller requires.
		if account.State != nil {
			state.SetStorage(addr, *account.State)
		}
		// Apply state diff into specified accounts.
		if account.StateDiff != nil {
			for key, value := range *account.StateDiff {
				state.SetState(addr, key, value)
			}
		}
	}
806
	// Set default gas & gas price if none were set
807 808 809
	gas := uint64(math.MaxUint64 / 2)
	if args.Gas != nil {
		gas = uint64(*args.Gas)
810
	}
811 812 813 814
	if globalGasCap != nil && globalGasCap.Uint64() < gas {
		log.Warn("Caller gas above allowance, capping", "requested", gas, "cap", globalGasCap)
		gas = globalGasCap.Uint64()
	}
815 816 817 818 819 820 821 822 823 824 825 826 827
	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)
828
	}
829 830

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

833 834 835
	// 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
836 837
	if timeout > 0 {
		ctx, cancel = context.WithTimeout(ctx, timeout)
838 839
	} else {
		ctx, cancel = context.WithCancel(ctx)
840
	}
841 842
	// Make sure the context is cancelled when the call has completed
	// this makes sure resources are cleaned up.
843
	defer cancel()
844 845

	// Get a new instance of the EVM.
846
	evm, vmError, err := b.GetEVM(ctx, msg, state, header)
847
	if err != nil {
848
		return nil, 0, false, err
849 850 851 852
	}
	// Wait for the context to be done and cancel the evm. Even if the
	// EVM has finished, cancelling may be done (repeatedly)
	go func() {
853 854
		<-ctx.Done()
		evm.Cancel()
855 856 857 858
	}()

	// Setup the gas pool (also for unmetered requests)
	// and apply the message.
859
	gp := new(core.GasPool).AddGas(math.MaxUint64)
860
	res, gas, failed, err := core.ApplyMessage(evm, msg, gp)
861
	if err := vmError(); err != nil {
862
		return nil, 0, false, err
863
	}
864 865 866 867
	// If the timer caused an abort, return an appropriate error message
	if evm.Cancelled() {
		return nil, 0, false, fmt.Errorf("execution aborted (timeout = %v)", timeout)
	}
868
	return res, gas, failed, err
869 870 871
}

// Call executes the given transaction on the state for the given block number.
872 873 874 875 876
//
// Additionally, the caller can specify a batch of contract for fields overriding.
//
// Note, this function doesn't make and changes in the state/blockchain and is
// useful to execute and retrieve values.
877
func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNrOrHash rpc.BlockNumberOrHash, overrides *map[common.Address]account) (hexutil.Bytes, error) {
878 879 880 881
	var accounts map[common.Address]account
	if overrides != nil {
		accounts = *overrides
	}
882
	result, _, _, err := DoCall(ctx, s.b, args, blockNrOrHash, accounts, vm.Config{}, 5*time.Second, s.b.RPCGasCap())
883
	return (hexutil.Bytes)(result), err
884 885
}

886
func DoEstimateGas(ctx context.Context, b Backend, args CallArgs, blockNrOrHash rpc.BlockNumberOrHash, gasCap *big.Int) (hexutil.Uint64, error) {
887
	// Binary search the gas requirement, as it may be higher than the amount used
888
	var (
889 890 891
		lo  uint64 = params.TxGas - 1
		hi  uint64
		cap uint64
892
	)
893 894
	if args.Gas != nil && uint64(*args.Gas) >= params.TxGas {
		hi = uint64(*args.Gas)
895
	} else {
896
		// Retrieve the block to act as the gas ceiling
897
		block, err := b.BlockByNumberOrHash(ctx, blockNrOrHash)
898
		if err != nil {
899
			return 0, err
900
		}
901
		hi = block.GasLimit()
902
	}
903 904 905 906
	if gasCap != nil && hi > gasCap.Uint64() {
		log.Warn("Caller gas above allowance, capping", "requested", hi, "cap", gasCap)
		hi = gasCap.Uint64()
	}
907
	cap = hi
908

909 910 911 912 913 914 915 916 917 918 919 920
	// Set sender address or use a default if none specified
	if args.From == nil {
		if wallets := b.AccountManager().Wallets(); len(wallets) > 0 {
			if accounts := wallets[0].Accounts(); len(accounts) > 0 {
				args.From = &accounts[0].Address
			}
		}
	}
	// Use zero-address if none other is available
	if args.From == nil {
		args.From = &common.Address{}
	}
921 922
	// Create a helper to check if a gas allowance results in an executable transaction
	executable := func(gas uint64) bool {
923
		args.Gas = (*hexutil.Uint64)(&gas)
924

925
		_, _, failed, err := DoCall(ctx, b, args, blockNrOrHash, nil, vm.Config{}, 0, gasCap)
926
		if err != nil || failed {
927 928 929 930 931 932 933 934
			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) {
935
			lo = mid
936 937 938 939 940 941 942
		} else {
			hi = mid
		}
	}
	// Reject the transaction as invalid if it still fails at the highest allowance
	if hi == cap {
		if !executable(hi) {
943
			return 0, fmt.Errorf("gas required exceeds allowance (%d) or always failing transaction", cap)
944 945
		}
	}
946
	return hexutil.Uint64(hi), nil
947 948
}

949 950 951
// 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) {
952 953
	blockNrOrHash := rpc.BlockNumberOrHashWithNumber(rpc.PendingBlockNumber)
	return DoEstimateGas(ctx, s.b, args, blockNrOrHash, s.b.RPCGasCap())
954 955
}

956
// ExecutionResult groups all structured logs emitted by the EVM
957 958
// while replaying a transaction in debug mode as well as transaction
// execution status, the amount of gas used and the return value
959
type ExecutionResult struct {
960
	Gas         uint64         `json:"gas"`
961
	Failed      bool           `json:"failed"`
962 963 964 965 966 967 968
	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 {
969 970 971 972 973 974 975 976 977
	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"`
978 979
}

980
// FormatLogs formats EVM returned structured logs for json output
981 982 983 984
func FormatLogs(logs []vm.StructLog) []StructLogRes {
	formatted := make([]StructLogRes, len(logs))
	for index, trace := range logs {
		formatted[index] = StructLogRes{
985 986 987 988 989 990 991
			Pc:      trace.Pc,
			Op:      trace.Op.String(),
			Gas:     trace.Gas,
			GasCost: trace.GasCost,
			Depth:   trace.Depth,
			Error:   trace.Err,
		}
992 993 994 995 996 997
		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
998
		}
999 1000 1001 1002 1003 1004
		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
1005
		}
1006 1007 1008 1009 1010 1011
		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
1012 1013
		}
	}
1014
	return formatted
1015 1016
}

1017 1018 1019
// RPCMarshalHeader converts the given header to the RPC output .
func RPCMarshalHeader(head *types.Header) map[string]interface{} {
	return map[string]interface{}{
1020
		"number":           (*hexutil.Big)(head.Number),
1021
		"hash":             head.Hash(),
1022 1023 1024 1025 1026 1027 1028
		"parentHash":       head.ParentHash,
		"nonce":            head.Nonce,
		"mixHash":          head.MixDigest,
		"sha3Uncles":       head.UncleHash,
		"logsBloom":        head.Bloom,
		"stateRoot":        head.Root,
		"miner":            head.Coinbase,
1029
		"difficulty":       (*hexutil.Big)(head.Difficulty),
1030
		"extraData":        hexutil.Bytes(head.Extra),
1031
		"size":             hexutil.Uint64(head.Size()),
1032 1033
		"gasLimit":         hexutil.Uint64(head.GasLimit),
		"gasUsed":          hexutil.Uint64(head.GasUsed),
1034
		"timestamp":        hexutil.Uint64(head.Time),
1035
		"transactionsRoot": head.TxHash,
1036
		"receiptsRoot":     head.ReceiptHash,
1037
	}
1038 1039 1040 1041 1042 1043 1044
}

// RPCMarshalBlock 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 RPCMarshalBlock(block *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
	fields := RPCMarshalHeader(block.Header())
1045
	fields["size"] = hexutil.Uint64(block.Size())
1046 1047 1048 1049 1050 1051 1052

	if inclTx {
		formatTx := func(tx *types.Transaction) (interface{}, error) {
			return tx.Hash(), nil
		}
		if fullTx {
			formatTx = func(tx *types.Transaction) (interface{}, error) {
1053
				return newRPCTransactionFromBlockHash(block, tx.Hash()), nil
1054 1055
			}
		}
1056
		txs := block.Transactions()
1057 1058
		transactions := make([]interface{}, len(txs))
		var err error
1059
		for i, tx := range txs {
1060 1061 1062 1063 1064 1065
			if transactions[i], err = formatTx(tx); err != nil {
				return nil, err
			}
		}
		fields["transactions"] = transactions
	}
1066
	uncles := block.Uncles()
1067 1068 1069 1070 1071 1072 1073 1074 1075
	uncleHashes := make([]common.Hash, len(uncles))
	for i, uncle := range uncles {
		uncleHashes[i] = uncle.Hash()
	}
	fields["uncles"] = uncleHashes

	return fields, nil
}

1076 1077 1078 1079 1080 1081 1082 1083 1084
// rpcMarshalHeader uses the generalized output filler, then adds the total difficulty field, which requires
// a `PublicBlockchainAPI`.
func (s *PublicBlockChainAPI) rpcMarshalHeader(header *types.Header) map[string]interface{} {
	fields := RPCMarshalHeader(header)
	fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(header.Hash()))
	return fields
}

// rpcMarshalBlock uses the generalized output filler, then adds the total difficulty field, which requires
1085
// a `PublicBlockchainAPI`.
1086
func (s *PublicBlockChainAPI) rpcMarshalBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
1087 1088 1089 1090
	fields, err := RPCMarshalBlock(b, inclTx, fullTx)
	if err != nil {
		return nil, err
	}
1091 1092 1093
	if inclTx {
		fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(b.Hash()))
	}
1094 1095 1096
	return fields, err
}

1097 1098
// RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction
type RPCTransaction struct {
1099
	BlockHash        *common.Hash    `json:"blockHash"`
1100
	BlockNumber      *hexutil.Big    `json:"blockNumber"`
1101
	From             common.Address  `json:"from"`
1102
	Gas              hexutil.Uint64  `json:"gas"`
1103
	GasPrice         *hexutil.Big    `json:"gasPrice"`
1104
	Hash             common.Hash     `json:"hash"`
1105
	Input            hexutil.Bytes   `json:"input"`
1106
	Nonce            hexutil.Uint64  `json:"nonce"`
1107
	To               *common.Address `json:"to"`
1108
	TransactionIndex *hexutil.Uint64 `json:"transactionIndex"`
1109 1110 1111 1112
	Value            *hexutil.Big    `json:"value"`
	V                *hexutil.Big    `json:"v"`
	R                *hexutil.Big    `json:"r"`
	S                *hexutil.Big    `json:"s"`
1113 1114
}

1115 1116 1117
// 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 {
1118 1119 1120 1121 1122
	var signer types.Signer = types.FrontierSigner{}
	if tx.Protected() {
		signer = types.NewEIP155Signer(tx.ChainId())
	}
	from, _ := types.Sender(signer, tx)
1123
	v, r, s := tx.RawSignatureValues()
1124 1125

	result := &RPCTransaction{
1126
		From:     from,
1127
		Gas:      hexutil.Uint64(tx.Gas()),
1128
		GasPrice: (*hexutil.Big)(tx.GasPrice()),
1129
		Hash:     tx.Hash(),
1130
		Input:    hexutil.Bytes(tx.Data()),
1131
		Nonce:    hexutil.Uint64(tx.Nonce()),
1132
		To:       tx.To(),
1133 1134 1135 1136
		Value:    (*hexutil.Big)(tx.Value()),
		V:        (*hexutil.Big)(v),
		R:        (*hexutil.Big)(r),
		S:        (*hexutil.Big)(s),
1137
	}
1138
	if blockHash != (common.Hash{}) {
1139
		result.BlockHash = &blockHash
1140
		result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber))
1141
		result.TransactionIndex = (*hexutil.Uint64)(&index)
1142 1143
	}
	return result
1144 1145
}

1146 1147 1148
// 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)
1149 1150
}

1151 1152 1153 1154 1155
// 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
1156
	}
1157 1158
	return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index)
}
1159

1160 1161 1162 1163 1164 1165 1166 1167
// 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
1168 1169
}

1170 1171
// newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction {
1172
	for idx, tx := range b.Transactions() {
1173 1174
		if tx.Hash() == hash {
			return newRPCTransactionFromBlockIndex(b, uint64(idx))
1175 1176
		}
	}
1177
	return nil
1178 1179 1180 1181
}

// PublicTransactionPoolAPI exposes methods for the RPC interface
type PublicTransactionPoolAPI struct {
1182 1183
	b         Backend
	nonceLock *AddrLocker
1184 1185 1186
}

// NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
1187 1188
func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI {
	return &PublicTransactionPoolAPI{b, nonceLock}
1189 1190 1191
}

// GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
1192
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
1193
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
1194 1195
		n := hexutil.Uint(len(block.Transactions()))
		return &n
1196 1197 1198 1199 1200
	}
	return nil
}

// GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
1201
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
1202
	if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
1203 1204
		n := hexutil.Uint(len(block.Transactions()))
		return &n
1205 1206 1207 1208 1209
	}
	return nil
}

// GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
1210
func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
1211
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
1212
		return newRPCTransactionFromBlockIndex(block, uint64(index))
1213
	}
1214
	return nil
1215 1216 1217
}

// GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
1218
func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
1219
	if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
1220
		return newRPCTransactionFromBlockIndex(block, uint64(index))
1221
	}
1222
	return nil
1223 1224
}

1225
// GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
1226
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
1227
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
1228
		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
1229
	}
1230
	return nil
1231 1232 1233
}

// GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
1234
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
1235
	if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
1236
		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
1237
	}
1238
	return nil
1239 1240
}

1241
// GetTransactionCount returns the number of transactions the given address has sent for the given block number
1242
func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (*hexutil.Uint64, error) {
1243
	// Ask transaction pool for the nonce which includes pending transactions
1244
	if blockNr, ok := blockNrOrHash.Number(); ok && blockNr == rpc.PendingBlockNumber {
1245 1246 1247 1248 1249 1250 1251
		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
1252
	state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
1253 1254 1255
	if state == nil || err != nil {
		return nil, err
	}
1256 1257
	nonce := state.GetNonce(address)
	return (*hexutil.Uint64)(&nonce), state.Error()
1258 1259 1260
}

// GetTransactionByHash returns the transaction for the given hash
1261
func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) (*RPCTransaction, error) {
1262
	// Try to return an already finalized transaction
1263 1264 1265 1266 1267 1268
	tx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash)
	if err != nil {
		return nil, err
	}
	if tx != nil {
		return newRPCTransaction(tx, blockHash, blockNumber, index), nil
1269
	}
1270 1271
	// No finalized transaction, try to retrieve it from the pool
	if tx := s.b.GetPoolTransaction(hash); tx != nil {
1272
		return newRPCPendingTransaction(tx), nil
1273
	}
1274

1275
	// Transaction unknown, return as such
1276
	return nil, nil
1277 1278
}

1279
// GetRawTransactionByHash returns the bytes of the transaction for the given hash.
1280
func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
1281
	// Retrieve a finalized transaction, or a pooled otherwise
1282 1283 1284 1285 1286
	tx, _, _, _, err := s.b.GetTransaction(ctx, hash)
	if err != nil {
		return nil, err
	}
	if tx == nil {
1287 1288 1289 1290
		if tx = s.b.GetPoolTransaction(hash); tx == nil {
			// Transaction not found anywhere, abort
			return nil, nil
		}
1291
	}
1292
	// Serialize to RLP and return
1293 1294 1295
	return rlp.EncodeToBytes(tx)
}

1296
// GetTransactionReceipt returns the transaction receipt for the given transaction hash.
1297
func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {
1298
	tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash)
1299
	if tx == nil {
1300
		return nil, nil
1301
	}
1302 1303 1304 1305 1306
	receipts, err := s.b.GetReceipts(ctx, blockHash)
	if err != nil {
		return nil, err
	}
	if len(receipts) <= int(index) {
1307
		return nil, nil
1308
	}
1309
	receipt := receipts[index]
1310

1311 1312 1313
	var signer types.Signer = types.FrontierSigner{}
	if tx.Protected() {
		signer = types.NewEIP155Signer(tx.ChainId())
1314
	}
1315
	from, _ := types.Sender(signer, tx)
1316 1317

	fields := map[string]interface{}{
1318 1319
		"blockHash":         blockHash,
		"blockNumber":       hexutil.Uint64(blockNumber),
1320
		"transactionHash":   hash,
1321
		"transactionIndex":  hexutil.Uint64(index),
1322 1323
		"from":              from,
		"to":                tx.To(),
1324 1325
		"gasUsed":           hexutil.Uint64(receipt.GasUsed),
		"cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed),
1326 1327
		"contractAddress":   nil,
		"logs":              receipt.Logs,
1328
		"logsBloom":         receipt.Bloom,
1329
	}
1330 1331 1332 1333 1334

	// Assign receipt status or post state.
	if len(receipt.PostState) > 0 {
		fields["root"] = hexutil.Bytes(receipt.PostState)
	} else {
1335
		fields["status"] = hexutil.Uint(receipt.Status)
1336
	}
1337
	if receipt.Logs == nil {
1338
		fields["logs"] = [][]*types.Log{}
1339 1340
	}
	// If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
1341
	if receipt.ContractAddress != (common.Address{}) {
1342 1343 1344 1345 1346 1347 1348
		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) {
1349 1350 1351 1352 1353 1354 1355 1356
	// 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
1357
	return wallet.SignTx(account, tx, s.b.ChainConfig().ChainID)
1358 1359 1360 1361 1362 1363
}

// 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"`
1364
	Gas      *hexutil.Uint64 `json:"gas"`
1365 1366 1367
	GasPrice *hexutil.Big    `json:"gasPrice"`
	Value    *hexutil.Big    `json:"value"`
	Nonce    *hexutil.Uint64 `json:"nonce"`
1368 1369 1370 1371
	// 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"`
1372 1373
}

1374
// setDefaults is a helper function that fills in default values for unspecified tx fields.
1375
func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
1376 1377 1378
	if args.GasPrice == nil {
		price, err := b.SuggestPrice(ctx)
		if err != nil {
1379
			return err
1380
		}
1381
		args.GasPrice = (*hexutil.Big)(price)
1382 1383
	}
	if args.Value == nil {
1384 1385 1386 1387 1388 1389 1390 1391 1392
		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)
	}
1393
	if args.Data != nil && args.Input != nil && !bytes.Equal(*args.Data, *args.Input) {
1394
		return errors.New(`both "data" and "input" are set and not equal. Please use "input" to pass transaction call data`)
1395
	}
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
	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`)
		}
	}
1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
	// Estimate the gas usage if necessary.
	if args.Gas == nil {
		// For backwards-compatibility reason, we try both input and data
		// but input is preferred.
		input := args.Input
		if input == nil {
			input = args.Data
		}
		callArgs := CallArgs{
			From:     &args.From, // From shouldn't be nil
			To:       args.To,
			GasPrice: args.GasPrice,
			Value:    args.Value,
			Data:     input,
		}
1423 1424
		pendingBlockNr := rpc.BlockNumberOrHashWithNumber(rpc.PendingBlockNumber)
		estimated, err := DoEstimateGas(ctx, b, callArgs, pendingBlockNr, b.RPCGasCap())
1425 1426 1427 1428 1429 1430
		if err != nil {
			return err
		}
		args.Gas = &estimated
		log.Trace("Estimate gas usage automatically", "gas", args.Gas)
	}
1431 1432 1433 1434
	return nil
}

func (args *SendTxArgs) toTransaction() *types.Transaction {
1435
	var input []byte
1436
	if args.Input != nil {
1437
		input = *args.Input
1438 1439
	} else if args.Data != nil {
		input = *args.Data
1440
	}
1441
	if args.To == nil {
1442
		return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
1443
	}
1444
	return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
1445 1446
}

1447 1448
// 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) {
1449
	if err := b.SendTx(ctx, tx); err != nil {
1450 1451
		return common.Hash{}, err
	}
1452 1453
	if tx.To() == nil {
		signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
1454 1455 1456 1457
		from, err := types.Sender(signer, tx)
		if err != nil {
			return common.Hash{}, err
		}
1458
		addr := crypto.CreateAddress(from, tx.Nonce())
1459
		log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
1460
	} else {
1461
		log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
1462
	}
1463
	return tx.Hash(), nil
1464 1465 1466 1467 1468
}

// 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) {
1469 1470 1471 1472 1473 1474 1475
	// 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
	}
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487

	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
	}
1488
	// Assemble the transaction and sign with the wallet
1489
	tx := args.toTransaction()
1490

1491
	signed, err := wallet.SignTx(account, tx, s.b.ChainConfig().ChainID)
1492 1493 1494
	if err != nil {
		return common.Hash{}, err
	}
1495
	return SubmitTransaction(ctx, s.b, signed)
1496 1497
}

1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
// FillTransaction fills the defaults (nonce, gas, gasPrice) on a given unsigned transaction,
// and returns it to the caller for further processing (signing + broadcast)
func (s *PublicTransactionPoolAPI) FillTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
	// Set some sanity defaults and terminate on failure
	if err := args.setDefaults(ctx, s.b); err != nil {
		return nil, err
	}
	// Assemble the transaction and obtain rlp
	tx := args.toTransaction()
	data, err := rlp.EncodeToBytes(tx)
	if err != nil {
		return nil, err
	}
	return &SignTransactionResult{data, tx}, nil
}

1514 1515
// SendRawTransaction will add the signed transaction to the transaction pool.
// The sender is responsible for signing the transaction and using the correct nonce.
1516
func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) {
1517
	tx := new(types.Transaction)
1518
	if err := rlp.DecodeBytes(encodedTx, tx); err != nil {
1519
		return common.Hash{}, err
1520
	}
1521
	return SubmitTransaction(ctx, s.b, tx)
1522 1523
}

1524 1525 1526
// Sign calculates an ECDSA signature for:
// keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
//
1527 1528 1529
// 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.
//
1530 1531 1532
// The account associated with addr must be unlocked.
//
// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
1533
func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
1534 1535 1536 1537 1538 1539 1540 1541
	// 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
1542
	signature, err := wallet.SignText(account, data)
1543
	if err == nil {
1544
		signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
1545 1546
	}
	return signature, err
1547 1548 1549 1550
}

// SignTransactionResult represents a RLP encoded signed transaction.
type SignTransactionResult struct {
1551 1552
	Raw hexutil.Bytes      `json:"raw"`
	Tx  *types.Transaction `json:"tx"`
1553 1554 1555 1556 1557
}

// 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.
1558
func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
1559 1560 1561 1562 1563 1564
	if args.Gas == nil {
		return nil, fmt.Errorf("gas not specified")
	}
	if args.GasPrice == nil {
		return nil, fmt.Errorf("gasPrice not specified")
	}
1565
	if args.Nonce == nil {
1566
		return nil, fmt.Errorf("nonce not specified")
1567
	}
1568 1569
	if err := args.setDefaults(ctx, s.b); err != nil {
		return nil, err
1570
	}
1571
	tx, err := s.sign(args.From, args.toTransaction())
1572 1573 1574
	if err != nil {
		return nil, err
	}
1575
	data, err := rlp.EncodeToBytes(tx)
1576 1577 1578
	if err != nil {
		return nil, err
	}
1579
	return &SignTransactionResult{data, tx}, nil
1580 1581
}

1582 1583
// PendingTransactions returns the transactions that are in the transaction pool
// and have a from address that is one of the accounts this node manages.
1584 1585 1586 1587 1588
func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return nil, err
	}
1589 1590 1591 1592 1593 1594
	accounts := make(map[common.Address]struct{})
	for _, wallet := range s.b.AccountManager().Wallets() {
		for _, account := range wallet.Accounts() {
			accounts[account.Address] = struct{}{}
		}
	}
1595 1596
	transactions := make([]*RPCTransaction, 0, len(pending))
	for _, tx := range pending {
1597 1598 1599 1600 1601
		var signer types.Signer = types.HomesteadSigner{}
		if tx.Protected() {
			signer = types.NewEIP155Signer(tx.ChainId())
		}
		from, _ := types.Sender(signer, tx)
1602
		if _, exists := accounts[from]; exists {
1603 1604 1605
			transactions = append(transactions, newRPCPendingTransaction(tx))
		}
	}
1606
	return transactions, nil
1607 1608
}

1609 1610
// 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.
1611
func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {
1612 1613 1614 1615 1616 1617 1618
	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()
1619 1620 1621 1622 1623
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return common.Hash{}, err
	}

1624
	for _, p := range pending {
1625 1626 1627 1628
		var signer types.Signer = types.HomesteadSigner{}
		if p.Protected() {
			signer = types.NewEIP155Signer(p.ChainId())
		}
1629
		wantSigHash := signer.Hash(matchTx)
1630

1631 1632
		if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash {
			// Match. Re-sign and send the transaction.
1633
			if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 {
1634
				sendArgs.GasPrice = gasPrice
1635
			}
1636
			if gasLimit != nil && *gasLimit != 0 {
1637
				sendArgs.Gas = gasLimit
1638
			}
1639
			signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())
1640 1641 1642 1643 1644 1645 1646 1647 1648 1649
			if err != nil {
				return common.Hash{}, err
			}
			if err = s.b.SendTx(ctx, signedTx); err != nil {
				return common.Hash{}, err
			}
			return signedTx.Hash(), nil
		}
	}

1650
	return common.Hash{}, fmt.Errorf("transaction %#x not found", matchTx.Hash())
1651 1652
}

1653
// PublicDebugAPI is the collection of Ethereum APIs exposed over the public
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677
// 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
}

1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
// TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the
// given address, returning the address of the recovered signature
//
// This is a temporary method to debug the externalsigner integration,
// TODO: Remove this method when the integration is mature
func (api *PublicDebugAPI) TestSignCliqueBlock(ctx context.Context, address common.Address, number uint64) (common.Address, error) {
	block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
	if block == nil {
		return common.Address{}, fmt.Errorf("block #%d not found", number)
	}
	header := block.Header()
	header.Extra = make([]byte, 32+65)
	encoded := clique.CliqueRLP(header)

	// Look up the wallet containing the requested signer
	account := accounts.Account{Address: address}
	wallet, err := api.b.AccountManager().Find(account)
	if err != nil {
		return common.Address{}, err
	}

	signature, err := wallet.SignData(account, accounts.MimetypeClique, encoded)
	if err != nil {
		return common.Address{}, err
	}
	sealHash := clique.SealHash(header).Bytes()
	log.Info("test signing of clique block",
		"Sealhash", fmt.Sprintf("%x", sealHash),
		"signature", fmt.Sprintf("%x", signature))
	pubkey, err := crypto.Ecrecover(sealHash, signature)
	if err != nil {
		return common.Address{}, err
	}
	var signer common.Address
	copy(signer[:], crypto.Keccak256(pubkey[1:])[12:])

	return signer, nil
}

1717 1718 1719 1720 1721 1722
// 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)
	}
1723
	return spew.Sdump(block), nil
1724 1725 1726 1727 1728 1729 1730 1731
}

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

1735
// PrivateDebugAPI is the collection of Ethereum APIs exposed over the private
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746
// 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}
}

1747
// ChaindbProperty returns leveldb properties of the key-value database.
1748 1749 1750 1751 1752 1753
func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) {
	if property == "" {
		property = "leveldb.stats"
	} else if !strings.HasPrefix(property, "leveldb.") {
		property = "leveldb." + property
	}
1754
	return api.b.ChainDb().Stat(property)
1755 1756
}

1757 1758
// ChaindbCompact flattens the entire key-value database into a single level,
// removing all unused slots and merging all keys.
1759 1760
func (api *PrivateDebugAPI) ChaindbCompact() error {
	for b := byte(0); b < 255; b++ {
1761
		log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
1762
		if err := api.b.ChainDb().Compact([]byte{b}, []byte{b + 1}); err != nil {
1763
			log.Error("Database compaction failed", "err", err)
1764 1765 1766 1767 1768 1769
			return err
		}
	}
	return nil
}

1770
// SetHead rewinds the head of the blockchain to a previous block.
1771 1772
func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
	api.b.SetHead(uint64(number))
1773 1774 1775 1776 1777
}

// PublicNetAPI offers network related RPC methods
type PublicNetAPI struct {
	net            *p2p.Server
1778
	networkVersion uint64
1779 1780 1781
}

// NewPublicNetAPI creates a new net API instance.
1782
func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
1783 1784 1785 1786 1787 1788 1789 1790 1791
	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
1792 1793
func (s *PublicNetAPI) PeerCount() hexutil.Uint {
	return hexutil.Uint(s.net.PeerCount())
1794 1795 1796 1797 1798 1799
}

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