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

27
	"github.com/davecgh/go-spew/spew"
28
	"github.com/ethereum/go-ethereum/accounts"
29
	"github.com/ethereum/go-ethereum/accounts/abi"
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/consensus/misc"
38
	"github.com/ethereum/go-ethereum/core"
39
	"github.com/ethereum/go-ethereum/core/state"
40 41 42
	"github.com/ethereum/go-ethereum/core/types"
	"github.com/ethereum/go-ethereum/core/vm"
	"github.com/ethereum/go-ethereum/crypto"
43
	"github.com/ethereum/go-ethereum/log"
44
	"github.com/ethereum/go-ethereum/p2p"
45
	"github.com/ethereum/go-ethereum/params"
46 47
	"github.com/ethereum/go-ethereum/rlp"
	"github.com/ethereum/go-ethereum/rpc"
48
	"github.com/tyler-smith/go-bip39"
49 50 51 52 53
)

// PublicEthereumAPI provides an API to access Ethereum related information.
// It offers only methods that operate on public data that is freely available to anyone.
type PublicEthereumAPI struct {
54
	b Backend
55 56
}

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

62
// GasPrice returns a suggestion for a gas price for legacy transactions.
63
func (s *PublicEthereumAPI) GasPrice(ctx context.Context) (*hexutil.Big, error) {
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
	tipcap, err := s.b.SuggestGasTipCap(ctx)
	if err != nil {
		return nil, err
	}
	if head := s.b.CurrentHeader(); head.BaseFee != nil {
		tipcap.Add(tipcap, head.BaseFee)
	}
	return (*hexutil.Big)(tipcap), err
}

// MaxPriorityFeePerGas returns a suggestion for a gas tip cap for dynamic transactions.
func (s *PublicEthereumAPI) MaxPriorityFeePerGas(ctx context.Context) (*hexutil.Big, error) {
	tipcap, err := s.b.SuggestGasTipCap(ctx)
	if err != nil {
		return nil, err
	}
	return (*hexutil.Big)(tipcap), err
81 82 83 84 85 86 87 88 89 90
}

// 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) {
91
	progress := s.b.Downloader().Progress()
92 93

	// Return not syncing if the synchronisation already completed
94
	if progress.CurrentBlock >= progress.HighestBlock {
95 96 97 98
		return false, nil
	}
	// Otherwise gather the block sync stats
	return map[string]interface{}{
99 100 101 102 103
		"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),
104 105 106 107 108 109 110 111 112 113 114 115 116 117
	}, 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.
118 119 120 121
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),
122 123
	}
	pending, queue := s.b.TxPoolContent()
124
	curHeader := s.b.CurrentHeader()
125
	// Flatten the pending transactions
126 127
	for account, txs := range pending {
		dump := make(map[string]*RPCTransaction)
128
		for _, tx := range txs {
129
			dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx, curHeader, s.b.ChainConfig())
130 131 132 133
		}
		content["pending"][account.Hex()] = dump
	}
	// Flatten the queued transactions
134 135
	for account, txs := range queue {
		dump := make(map[string]*RPCTransaction)
136
		for _, tx := range txs {
137
			dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx, curHeader, s.b.ChainConfig())
138 139 140 141 142 143 144
		}
		content["queued"][account.Hex()] = dump
	}
	return content
}

// Status returns the number of pending and queued transaction in the pool.
145
func (s *PublicTxPoolAPI) Status() map[string]hexutil.Uint {
146
	pending, queue := s.b.Stats()
147 148 149
	return map[string]hexutil.Uint{
		"pending": hexutil.Uint(pending),
		"queued":  hexutil.Uint(queue),
150 151 152 153 154
	}
}

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

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

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

222
// listAccounts will return a list of addresses for accounts this node manages.
223
func (s *PrivateAccountAPI) ListAccounts() []common.Address {
224
	return s.am.Accounts()
225 226
}

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

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

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

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

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

288 289
// NewAccount will create a new account and returns the address for the new account.
func (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) {
290 291 292 293 294
	ks, err := fetchKeystore(s.am)
	if err != nil {
		return common.Address{}, err
	}
	acc, err := ks.NewAccount(password)
295
	if err == nil {
296 297 298
		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!")
299 300 301 302 303
		return acc.Address, nil
	}
	return common.Address{}, err
}

304
// fetchKeystore retrieves the encrypted keystore from the account manager.
305 306 307 308 309
func fetchKeystore(am *accounts.Manager) (*keystore.KeyStore, error) {
	if ks := am.Backends(keystore.KeyStoreType); len(ks) > 0 {
		return ks[0].(*keystore.KeyStore), nil
	}
	return nil, errors.New("local keystore not used")
310 311
}

312 313 314
// 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) {
315
	key, err := crypto.HexToECDSA(privkey)
316 317 318
	if err != nil {
		return common.Address{}, err
	}
319 320 321 322 323
	ks, err := fetchKeystore(s.am)
	if err != nil {
		return common.Address{}, err
	}
	acc, err := ks.ImportECDSA(key, password)
324 325 326 327 328 329
	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.
330 331 332 333 334 335 336 337
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")
	}

338
	const max = uint64(time.Duration(math.MaxInt64) / time.Second)
339
	var d time.Duration
340
	if duration == nil {
341
		d = 300 * time.Second
342 343
	} else if *duration > max {
		return false, errors.New("unlock duration too large")
344 345
	} else {
		d = time.Duration(*duration) * time.Second
346
	}
347 348 349 350 351
	ks, err := fetchKeystore(s.am)
	if err != nil {
		return false, err
	}
	err = ks.TimedUnlock(accounts.Account{Address: addr}, password, d)
352 353 354
	if err != nil {
		log.Warn("Failed account unlock attempt", "address", addr, "err", err)
	}
355
	return err == nil, err
356 357 358 359
}

// LockAccount will lock the account associated with the given address when it's unlocked.
func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool {
360 361 362 363
	if ks, err := fetchKeystore(s.am); err == nil {
		return ks.Lock(addr) == nil
	}
	return false
364 365
}

366
// signTransaction sets defaults and signs the given transaction
367 368
// 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
369
func (s *PrivateAccountAPI) signTransaction(ctx context.Context, args *TransactionArgs, passwd string) (*types.Transaction, error) {
370
	// Look up the wallet containing the requested signer
371
	account := accounts.Account{Address: args.from()}
372 373
	wallet, err := s.am.Find(account)
	if err != nil {
374
		return nil, err
375 376 377
	}
	// Set some sanity defaults and terminate on failure
	if err := args.setDefaults(ctx, s.b); err != nil {
378
		return nil, err
379
	}
380
	// Assemble the transaction and sign with the wallet
381
	tx := args.toTransaction()
382

383
	return wallet.SignTxWithPassphrase(account, passwd, tx, s.b.ChainConfig().ChainID)
384 385 386
}

// SendTransaction will create a transaction from the given arguments and
387 388 389
// tries to sign it with the key associated with args.From. If the given
// passwd isn't able to decrypt the key it fails.
func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args TransactionArgs, passwd string) (common.Hash, error) {
390 391 392
	if args.Nonce == nil {
		// Hold the addresse's mutex around signing to prevent concurrent assignment of
		// the same nonce to multiple accounts.
393 394
		s.nonceLock.LockAddr(args.from())
		defer s.nonceLock.UnlockAddr(args.from())
395
	}
396
	signed, err := s.signTransaction(ctx, &args, passwd)
397
	if err != nil {
398
		log.Warn("Failed transaction send attempt", "from", args.from(), "to", args.To, "value", args.Value.ToInt(), "err", err)
399 400
		return common.Hash{}, err
	}
401
	return SubmitTransaction(ctx, s.b, signed)
402 403
}

404
// SignTransaction will create a transaction from the given arguments and
405
// tries to sign it with the key associated with args.From. If the given passwd isn't
406 407
// able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast
// to other nodes
408
func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args TransactionArgs, passwd string) (*SignTransactionResult, error) {
409 410
	// 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
411 412 413
	if args.From == nil {
		return nil, fmt.Errorf("sender not specified")
	}
414 415 416 417 418 419 420 421 422
	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")
	}
423 424 425 426
	// Before actually sign the transaction, ensure the transaction fee is reasonable.
	if err := checkTxFee(args.GasPrice.ToInt(), uint64(*args.Gas), s.b.RPCTxFeeCap()); err != nil {
		return nil, err
	}
427
	signed, err := s.signTransaction(ctx, &args, passwd)
428
	if err != nil {
429
		log.Warn("Failed transaction sign attempt", "from", args.from(), "to", args.To, "value", args.Value.ToInt(), "err", err)
430 431
		return nil, err
	}
432
	data, err := signed.MarshalBinary()
433 434 435 436 437 438
	if err != nil {
		return nil, err
	}
	return &SignTransactionResult{data, signed}, nil
}

439 440 441
// Sign calculates an Ethereum ECDSA signature for:
// keccack256("\x19Ethereum Signed Message:\n" + len(message) + message))
//
442 443 444
// 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.
//
445 446 447
// The key used to calculate the signature is decrypted with the given password.
//
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign
448
func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {
449 450 451 452 453 454 455 456
	// 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
457
	signature, err := wallet.SignTextWithPassphrase(account, passwd, data)
458
	if err != nil {
459
		log.Warn("Failed data sign attempt", "address", addr, "err", err)
460 461
		return nil, err
	}
462
	signature[crypto.RecoveryIDOffset] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
463
	return signature, nil
464 465 466 467 468 469 470 471
}

// 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)
//
472
// Note, the signature must conform to the secp256k1 curve R, S and V values, where
473
// the V value must be 27 or 28 for legacy reasons.
474
//
475
// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover
476
func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {
477 478
	if len(sig) != crypto.SignatureLength {
		return common.Address{}, fmt.Errorf("signature must be %d bytes long", crypto.SignatureLength)
479
	}
480
	if sig[crypto.RecoveryIDOffset] != 27 && sig[crypto.RecoveryIDOffset] != 28 {
481
		return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)")
482
	}
483
	sig[crypto.RecoveryIDOffset] -= 27 // Transform yellow paper V from 27/28 to 0/1
484

485
	rpk, err := crypto.SigToPub(accounts.TextHash(data), sig)
486 487 488
	if err != nil {
		return common.Address{}, err
	}
489
	return crypto.PubkeyToAddress(*rpk), nil
490 491
}

492 493
// 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.
494
func (s *PrivateAccountAPI) SignAndSendTransaction(ctx context.Context, args TransactionArgs, passwd string) (common.Hash, error) {
495 496 497
	return s.SendTransaction(ctx, args, passwd)
}

498
// InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key.
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
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:
521
		return "", fmt.Errorf("specified wallet does not support initialization")
522 523 524
	}
}

525
// Unpair deletes a pairing between wallet and geth.
526 527 528 529 530 531 532 533 534 535
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:
536
		return fmt.Errorf("specified wallet does not support pairing")
537 538 539
	}
}

540 541 542
// 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 {
543
	b Backend
544 545
}

546
// NewPublicBlockChainAPI creates a new Ethereum blockchain API.
547
func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI {
548
	return &PublicBlockChainAPI{b}
549 550
}

551 552 553 554 555 556 557
// ChainId is the EIP-155 replay-protection chain id for the current ethereum chain config.
func (api *PublicBlockChainAPI) ChainId() (*hexutil.Big, error) {
	// if current block is at or past the EIP-155 replay-protection fork block, return chainID from config
	if config := api.b.ChainConfig(); config.IsEIP155(api.b.CurrentBlock().Number()) {
		return (*hexutil.Big)(config.ChainID), nil
	}
	return nil, fmt.Errorf("chain not synced beyond EIP-155 replay-protection fork block")
558 559
}

560
// BlockNumber returns the block number of the chain head.
561
func (s *PublicBlockChainAPI) BlockNumber() hexutil.Uint64 {
562
	header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available
563
	return hexutil.Uint64(header.Number.Uint64())
564 565 566 567 568
}

// 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.
569 570
func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (*hexutil.Big, error) {
	state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
571 572 573
	if state == nil || err != nil {
		return nil, err
	}
574
	return (*hexutil.Big)(state.GetBalance(address)), state.Error()
575 576
}

577 578 579 580 581 582 583 584 585 586
// 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"`
}
587

588 589 590 591 592 593 594
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.
595 596
func (s *PublicBlockChainAPI) GetProof(ctx context.Context, address common.Address, storageKeys []string, blockNrOrHash rpc.BlockNumberOrHash) (*AccountResult, error) {
	state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
	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
			}
621
			storageProof[i] = StorageResult{key, (*hexutil.Big)(state.GetState(address, common.HexToHash(key)).Big()), toHexSlice(proof)}
622 623 624 625 626 627 628 629 630 631 632 633 634
		} 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,
635
		AccountProof: toHexSlice(accountProof),
636 637 638 639 640 641 642 643
		Balance:      (*hexutil.Big)(state.GetBalance(address)),
		CodeHash:     codeHash,
		Nonce:        hexutil.Uint64(state.GetNonce(address)),
		StorageHash:  storageHash,
		StorageProof: storageProof,
	}, state.Error()
}

644 645 646 647 648 649
// 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 {
650
		response := s.rpcMarshalHeader(ctx, header)
651 652 653 654 655 656 657 658 659 660 661 662 663
		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{} {
664
	header, _ := s.b.HeaderByHash(ctx, hash)
665
	if header != nil {
666
		return s.rpcMarshalHeader(ctx, header)
667 668 669 670 671 672 673 674 675 676 677 678
	}
	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 {
679
		response, err := s.rpcMarshalBlock(ctx, block, true, fullTx)
680
		if err == nil && number == rpc.PendingBlockNumber {
681
			// Pending blocks need to nil out a few fields
682
			for _, field := range []string{"hash", "nonce", "miner"} {
683 684 685 686 687 688 689 690 691 692
				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.
693
func (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, hash common.Hash, fullTx bool) (map[string]interface{}, error) {
694
	block, err := s.b.BlockByHash(ctx, hash)
695
	if block != nil {
696
		return s.rpcMarshalBlock(ctx, block, true, fullTx)
697 698 699 700 701 702
	}
	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.
703
func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {
704 705 706
	block, err := s.b.BlockByNumber(ctx, blockNr)
	if block != nil {
		uncles := block.Uncles()
707
		if index >= hexutil.Uint(len(uncles)) {
708
			log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index)
709 710
			return nil, nil
		}
711
		block = types.NewBlockWithHeader(uncles[index])
712
		return s.rpcMarshalBlock(ctx, block, false, false)
713 714 715 716 717 718
	}
	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.
719
func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {
720
	block, err := s.b.BlockByHash(ctx, blockHash)
721 722
	if block != nil {
		uncles := block.Uncles()
723
		if index >= hexutil.Uint(len(uncles)) {
724
			log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index)
725 726
			return nil, nil
		}
727
		block = types.NewBlockWithHeader(uncles[index])
728
		return s.rpcMarshalBlock(ctx, block, false, false)
729 730 731 732 733
	}
	return nil, err
}

// GetUncleCountByBlockNumber returns number of uncles in the block for the given block number
734
func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
735
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
736 737
		n := hexutil.Uint(len(block.Uncles()))
		return &n
738 739 740 741 742
	}
	return nil
}

// GetUncleCountByBlockHash returns number of uncles in the block for the given block hash
743
func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
744
	if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
745 746
		n := hexutil.Uint(len(block.Uncles()))
		return &n
747 748 749 750 751
	}
	return nil
}

// GetCode returns the code stored at the given address in the state for the given block number.
752 753
func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (hexutil.Bytes, error) {
	state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
754
	if state == nil || err != nil {
755
		return nil, err
756
	}
757 758
	code := state.GetCode(address)
	return code, state.Error()
759 760 761 762 763
}

// 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.
764 765
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)
766
	if state == nil || err != nil {
767
		return nil, err
768
	}
769 770
	res := state.GetState(address, common.HexToHash(key))
	return res[:], state.Error()
771 772
}

773 774
// OverrideAccount indicates the overriding fields of account during the execution
// of a message call.
775 776 777 778
// 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.
779
type OverrideAccount struct {
780 781 782 783 784 785 786
	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"`
}

787
// StateOverride is the collection of overridden accounts.
788
type StateOverride map[common.Address]OverrideAccount
789

790 791 792 793
// Apply overrides the fields of specified accounts into the given state.
func (diff *StateOverride) Apply(state *state.StateDB) error {
	if diff == nil {
		return nil
794
	}
795
	for addr, account := range *diff {
796 797 798 799 800 801 802 803 804 805 806 807 808
		// 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 {
809
			return fmt.Errorf("account %s has both 'state' and 'stateDiff'", addr.Hex())
810 811 812 813 814 815 816 817 818 819 820 821
		}
		// 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)
			}
		}
	}
822 823 824
	return nil
}

825
func DoCall(ctx context.Context, b Backend, args TransactionArgs, blockNrOrHash rpc.BlockNumberOrHash, overrides *StateOverride, timeout time.Duration, globalGasCap uint64) (*core.ExecutionResult, error) {
826 827 828 829 830 831 832 833 834
	defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now())

	state, header, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
	if state == nil || err != nil {
		return nil, err
	}
	if err := overrides.Apply(state); err != nil {
		return nil, err
	}
835 836 837
	// 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
838 839
	if timeout > 0 {
		ctx, cancel = context.WithTimeout(ctx, timeout)
840 841
	} else {
		ctx, cancel = context.WithCancel(ctx)
842
	}
843 844
	// Make sure the context is cancelled when the call has completed
	// this makes sure resources are cleaned up.
845
	defer cancel()
846 847

	// Get a new instance of the EVM.
848 849 850 851
	msg, err := args.ToMessage(globalGasCap, header.BaseFee)
	if err != nil {
		return nil, err
	}
852
	evm, vmError, err := b.GetEVM(ctx, msg, state, header, &vm.Config{NoBaseFee: true})
853
	if err != nil {
854
		return nil, err
855 856 857 858
	}
	// Wait for the context to be done and cancel the evm. Even if the
	// EVM has finished, cancelling may be done (repeatedly)
	go func() {
859 860
		<-ctx.Done()
		evm.Cancel()
861 862
	}()

863
	// Execute the message.
864
	gp := new(core.GasPool).AddGas(math.MaxUint64)
865
	result, err := core.ApplyMessage(evm, msg, gp)
866
	if err := vmError(); err != nil {
867
		return nil, err
868
	}
869

870 871
	// If the timer caused an abort, return an appropriate error message
	if evm.Cancelled() {
872
		return nil, fmt.Errorf("execution aborted (timeout = %v)", timeout)
873
	}
874 875 876 877
	if err != nil {
		return result, fmt.Errorf("err: %w (supplied gas %d)", err, msg.Gas())
	}
	return result, nil
878 879
}

880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
func newRevertError(result *core.ExecutionResult) *revertError {
	reason, errUnpack := abi.UnpackRevert(result.Revert())
	err := errors.New("execution reverted")
	if errUnpack == nil {
		err = fmt.Errorf("execution reverted: %v", reason)
	}
	return &revertError{
		error:  err,
		reason: hexutil.Encode(result.Revert()),
	}
}

// revertError is an API error that encompassas an EVM revertal with JSON error
// code and a binary data blob.
type revertError struct {
	error
	reason string // revert reason hex encoded
}

// ErrorCode returns the JSON error code for a revertal.
// See: https://github.com/ethereum/wiki/wiki/JSON-RPC-Error-Codes-Improvement-Proposal
func (e *revertError) ErrorCode() int {
	return 3
}

// ErrorData returns the hex encoded revert reason.
func (e *revertError) ErrorData() interface{} {
	return e.reason
}

910
// Call executes the given transaction on the state for the given block number.
911 912 913 914 915
//
// 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.
916
func (s *PublicBlockChainAPI) Call(ctx context.Context, args TransactionArgs, blockNrOrHash rpc.BlockNumberOrHash, overrides *StateOverride) (hexutil.Bytes, error) {
917
	result, err := DoCall(ctx, s.b, args, blockNrOrHash, overrides, 5*time.Second, s.b.RPCGasCap())
918 919 920
	if err != nil {
		return nil, err
	}
921 922 923
	// If the result contains a revert reason, try to unpack and return it.
	if len(result.Revert()) > 0 {
		return nil, newRevertError(result)
924
	}
925
	return result.Return(), result.Err
926 927
}

928
func DoEstimateGas(ctx context.Context, b Backend, args TransactionArgs, blockNrOrHash rpc.BlockNumberOrHash, gasCap uint64) (hexutil.Uint64, error) {
929
	// Binary search the gas requirement, as it may be higher than the amount used
930
	var (
931 932 933
		lo  uint64 = params.TxGas - 1
		hi  uint64
		cap uint64
934
	)
935 936 937 938 939
	// Use zero address if sender unspecified.
	if args.From == nil {
		args.From = new(common.Address)
	}
	// Determine the highest gas limit can be used during the estimation.
940 941
	if args.Gas != nil && uint64(*args.Gas) >= params.TxGas {
		hi = uint64(*args.Gas)
942
	} else {
943
		// Retrieve the block to act as the gas ceiling
944
		block, err := b.BlockByNumberOrHash(ctx, blockNrOrHash)
945
		if err != nil {
946
			return 0, err
947
		}
948 949 950
		if block == nil {
			return 0, errors.New("block not found")
		}
951
		hi = block.GasLimit()
952
	}
953
	// Recap the highest gas limit with account's available balance.
954
	if args.GasPrice != nil && args.GasPrice.ToInt().BitLen() != 0 {
955 956 957 958 959 960 961 962 963 964 965 966 967
		state, _, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
		if err != nil {
			return 0, err
		}
		balance := state.GetBalance(*args.From) // from can't be nil
		available := new(big.Int).Set(balance)
		if args.Value != nil {
			if args.Value.ToInt().Cmp(available) >= 0 {
				return 0, errors.New("insufficient funds for transfer")
			}
			available.Sub(available, args.Value.ToInt())
		}
		allowance := new(big.Int).Div(available, args.GasPrice.ToInt())
968 969 970

		// If the allowance is larger than maximum uint64, skip checking
		if allowance.IsUint64() && hi > allowance.Uint64() {
971 972 973 974 975 976 977 978 979 980
			transfer := args.Value
			if transfer == nil {
				transfer = new(hexutil.Big)
			}
			log.Warn("Gas estimation capped by limited funds", "original", hi, "balance", balance,
				"sent", transfer.ToInt(), "gasprice", args.GasPrice.ToInt(), "fundable", allowance)
			hi = allowance.Uint64()
		}
	}
	// Recap the highest gas allowance with specified gascap.
981
	if gasCap != 0 && hi > gasCap {
982
		log.Warn("Caller gas above allowance, capping", "requested", hi, "cap", gasCap)
983
		hi = gasCap
984
	}
985
	cap = hi
986

987
	// Create a helper to check if a gas allowance results in an executable transaction
988
	executable := func(gas uint64) (bool, *core.ExecutionResult, error) {
989
		args.Gas = (*hexutil.Uint64)(&gas)
990

991
		result, err := DoCall(ctx, b, args, blockNrOrHash, nil, 0, gasCap)
992
		if err != nil {
993
			if errors.Is(err, core.ErrIntrinsicGas) {
994 995 996
				return true, nil, nil // Special case, raise gas limit
			}
			return true, nil, err // Bail out
997
		}
998
		return result.Failed(), result, nil
999 1000 1001 1002
	}
	// Execute the binary search and hone in on an executable gas limit
	for lo+1 < hi {
		mid := (hi + lo) / 2
1003 1004 1005 1006
		failed, _, err := executable(mid)

		// If the error is not nil(consensus error), it means the provided message
		// call or transaction will never be accepted no matter how much gas it is
1007
		// assigned. Return the error directly, don't struggle any more.
1008 1009 1010 1011
		if err != nil {
			return 0, err
		}
		if failed {
1012
			lo = mid
1013 1014 1015 1016 1017 1018
		} else {
			hi = mid
		}
	}
	// Reject the transaction as invalid if it still fails at the highest allowance
	if hi == cap {
1019 1020 1021 1022 1023 1024 1025
		failed, result, err := executable(hi)
		if err != nil {
			return 0, err
		}
		if failed {
			if result != nil && result.Err != vm.ErrOutOfGas {
				if len(result.Revert()) > 0 {
1026
					return 0, newRevertError(result)
1027
				}
1028
				return 0, result.Err
1029 1030
			}
			// Otherwise, the specified gas cap is too low
1031
			return 0, fmt.Errorf("gas required exceeds allowance (%d)", cap)
1032 1033
		}
	}
1034
	return hexutil.Uint64(hi), nil
1035 1036
}

1037 1038
// EstimateGas returns an estimate of the amount of gas needed to execute the
// given transaction against the current pending block.
1039
func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args TransactionArgs, blockNrOrHash *rpc.BlockNumberOrHash) (hexutil.Uint64, error) {
1040 1041 1042 1043 1044
	bNrOrHash := rpc.BlockNumberOrHashWithNumber(rpc.PendingBlockNumber)
	if blockNrOrHash != nil {
		bNrOrHash = *blockNrOrHash
	}
	return DoEstimateGas(ctx, s.b, args, bNrOrHash, s.b.RPCGasCap())
1045 1046
}

1047
// ExecutionResult groups all structured logs emitted by the EVM
1048 1049
// while replaying a transaction in debug mode as well as transaction
// execution status, the amount of gas used and the return value
1050
type ExecutionResult struct {
1051
	Gas         uint64         `json:"gas"`
1052
	Failed      bool           `json:"failed"`
1053 1054 1055 1056 1057 1058 1059
	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 {
1060 1061 1062 1063 1064 1065 1066 1067 1068
	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"`
1069 1070
}

1071
// FormatLogs formats EVM returned structured logs for json output
1072 1073 1074 1075
func FormatLogs(logs []vm.StructLog) []StructLogRes {
	formatted := make([]StructLogRes, len(logs))
	for index, trace := range logs {
		formatted[index] = StructLogRes{
1076 1077 1078 1079 1080 1081 1082
			Pc:      trace.Pc,
			Op:      trace.Op.String(),
			Gas:     trace.Gas,
			GasCost: trace.GasCost,
			Depth:   trace.Depth,
			Error:   trace.Err,
		}
1083 1084 1085 1086 1087 1088
		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
1089
		}
1090 1091 1092 1093 1094 1095
		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
1096
		}
1097 1098 1099 1100 1101 1102
		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
1103 1104
		}
	}
1105
	return formatted
1106 1107
}

1108 1109
// RPCMarshalHeader converts the given header to the RPC output .
func RPCMarshalHeader(head *types.Header) map[string]interface{} {
1110
	result := map[string]interface{}{
1111
		"number":           (*hexutil.Big)(head.Number),
1112
		"hash":             head.Hash(),
1113 1114 1115 1116 1117 1118 1119
		"parentHash":       head.ParentHash,
		"nonce":            head.Nonce,
		"mixHash":          head.MixDigest,
		"sha3Uncles":       head.UncleHash,
		"logsBloom":        head.Bloom,
		"stateRoot":        head.Root,
		"miner":            head.Coinbase,
1120
		"difficulty":       (*hexutil.Big)(head.Difficulty),
1121
		"extraData":        hexutil.Bytes(head.Extra),
1122
		"size":             hexutil.Uint64(head.Size()),
1123 1124
		"gasLimit":         hexutil.Uint64(head.GasLimit),
		"gasUsed":          hexutil.Uint64(head.GasUsed),
1125
		"timestamp":        hexutil.Uint64(head.Time),
1126
		"transactionsRoot": head.TxHash,
1127
		"receiptsRoot":     head.ReceiptHash,
1128
	}
1129 1130 1131 1132 1133 1134

	if head.BaseFee != nil {
		result["baseFeePerGas"] = (*hexutil.Big)(head.BaseFee)
	}

	return result
1135 1136 1137 1138 1139 1140 1141
}

// 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())
1142
	fields["size"] = hexutil.Uint64(block.Size())
1143 1144 1145 1146 1147 1148 1149

	if inclTx {
		formatTx := func(tx *types.Transaction) (interface{}, error) {
			return tx.Hash(), nil
		}
		if fullTx {
			formatTx = func(tx *types.Transaction) (interface{}, error) {
1150
				return newRPCTransactionFromBlockHash(block, tx.Hash()), nil
1151 1152
			}
		}
1153
		txs := block.Transactions()
1154 1155
		transactions := make([]interface{}, len(txs))
		var err error
1156
		for i, tx := range txs {
1157 1158 1159 1160 1161 1162
			if transactions[i], err = formatTx(tx); err != nil {
				return nil, err
			}
		}
		fields["transactions"] = transactions
	}
1163
	uncles := block.Uncles()
1164 1165 1166 1167 1168 1169 1170 1171 1172
	uncleHashes := make([]common.Hash, len(uncles))
	for i, uncle := range uncles {
		uncleHashes[i] = uncle.Hash()
	}
	fields["uncles"] = uncleHashes

	return fields, nil
}

1173 1174
// rpcMarshalHeader uses the generalized output filler, then adds the total difficulty field, which requires
// a `PublicBlockchainAPI`.
1175
func (s *PublicBlockChainAPI) rpcMarshalHeader(ctx context.Context, header *types.Header) map[string]interface{} {
1176
	fields := RPCMarshalHeader(header)
1177
	fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(ctx, header.Hash()))
1178 1179 1180 1181
	return fields
}

// rpcMarshalBlock uses the generalized output filler, then adds the total difficulty field, which requires
1182
// a `PublicBlockchainAPI`.
1183
func (s *PublicBlockChainAPI) rpcMarshalBlock(ctx context.Context, b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
1184 1185 1186 1187
	fields, err := RPCMarshalBlock(b, inclTx, fullTx)
	if err != nil {
		return nil, err
	}
1188
	if inclTx {
1189
		fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(ctx, b.Hash()))
1190
	}
1191 1192 1193
	return fields, err
}

1194 1195
// RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction
type RPCTransaction struct {
1196 1197 1198 1199 1200
	BlockHash        *common.Hash      `json:"blockHash"`
	BlockNumber      *hexutil.Big      `json:"blockNumber"`
	From             common.Address    `json:"from"`
	Gas              hexutil.Uint64    `json:"gas"`
	GasPrice         *hexutil.Big      `json:"gasPrice"`
1201 1202
	GasFeeCap        *hexutil.Big      `json:"maxFeePerGas,omitempty"`
	GasTipCap        *hexutil.Big      `json:"maxPriorityFeePerGas,omitempty"`
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
	Hash             common.Hash       `json:"hash"`
	Input            hexutil.Bytes     `json:"input"`
	Nonce            hexutil.Uint64    `json:"nonce"`
	To               *common.Address   `json:"to"`
	TransactionIndex *hexutil.Uint64   `json:"transactionIndex"`
	Value            *hexutil.Big      `json:"value"`
	Type             hexutil.Uint64    `json:"type"`
	Accesses         *types.AccessList `json:"accessList,omitempty"`
	ChainID          *hexutil.Big      `json:"chainId,omitempty"`
	V                *hexutil.Big      `json:"v"`
	R                *hexutil.Big      `json:"r"`
	S                *hexutil.Big      `json:"s"`
1215 1216
}

1217 1218
// newRPCTransaction returns a transaction that will serialize to the RPC
// representation, with the given location metadata set (if available).
1219
func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64, baseFee *big.Int) *RPCTransaction {
1220 1221 1222 1223 1224
	// Determine the signer. For replay-protected transactions, use the most permissive
	// signer, because we assume that signers are backwards-compatible with old
	// transactions. For non-protected transactions, the homestead signer signer is used
	// because the return value of ChainId is zero for those transactions.
	var signer types.Signer
1225
	if tx.Protected() {
1226 1227 1228
		signer = types.LatestSignerForChainID(tx.ChainId())
	} else {
		signer = types.HomesteadSigner{}
1229 1230
	}
	from, _ := types.Sender(signer, tx)
1231
	v, r, s := tx.RawSignatureValues()
1232
	result := &RPCTransaction{
1233
		Type:     hexutil.Uint64(tx.Type()),
1234
		From:     from,
1235
		Gas:      hexutil.Uint64(tx.Gas()),
1236
		GasPrice: (*hexutil.Big)(tx.GasPrice()),
1237
		Hash:     tx.Hash(),
1238
		Input:    hexutil.Bytes(tx.Data()),
1239
		Nonce:    hexutil.Uint64(tx.Nonce()),
1240
		To:       tx.To(),
1241 1242 1243 1244
		Value:    (*hexutil.Big)(tx.Value()),
		V:        (*hexutil.Big)(v),
		R:        (*hexutil.Big)(r),
		S:        (*hexutil.Big)(s),
1245
	}
1246
	if blockHash != (common.Hash{}) {
1247
		result.BlockHash = &blockHash
1248
		result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber))
1249
		result.TransactionIndex = (*hexutil.Uint64)(&index)
1250
	}
1251 1252 1253 1254 1255 1256
	switch tx.Type() {
	case types.AccessListTxType:
		al := tx.AccessList()
		result.Accesses = &al
		result.ChainID = (*hexutil.Big)(tx.ChainId())
	case types.DynamicFeeTxType:
1257 1258 1259
		al := tx.AccessList()
		result.Accesses = &al
		result.ChainID = (*hexutil.Big)(tx.ChainId())
1260 1261
		result.GasFeeCap = (*hexutil.Big)(tx.GasFeeCap())
		result.GasTipCap = (*hexutil.Big)(tx.GasTipCap())
1262 1263
		// if the transaction has been mined, compute the effective gas price
		if baseFee != nil && blockHash != (common.Hash{}) {
1264 1265
			// price = min(tip, gasFeeCap - baseFee) + baseFee
			price := math.BigMin(new(big.Int).Add(tx.GasTipCap(), baseFee), tx.GasFeeCap())
1266 1267 1268 1269
			result.GasPrice = (*hexutil.Big)(price)
		} else {
			result.GasPrice = nil
		}
1270
	}
1271
	return result
1272 1273
}

1274
// newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation
1275 1276 1277 1278 1279 1280
func newRPCPendingTransaction(tx *types.Transaction, current *types.Header, config *params.ChainConfig) *RPCTransaction {
	var baseFee *big.Int
	if current != nil {
		baseFee = misc.CalcBaseFee(config, current)
	}
	return newRPCTransaction(tx, common.Hash{}, 0, 0, baseFee)
1281 1282
}

1283 1284 1285 1286 1287
// 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
1288
	}
1289
	return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index, b.BaseFee())
1290
}
1291

1292 1293 1294 1295 1296 1297
// 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
	}
1298
	blob, _ := txs[index].MarshalBinary()
1299
	return blob
1300 1301
}

1302 1303
// newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction {
1304
	for idx, tx := range b.Transactions() {
1305 1306
		if tx.Hash() == hash {
			return newRPCTransactionFromBlockIndex(b, uint64(idx))
1307 1308
		}
	}
1309
	return nil
1310 1311
}

1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
// accessListResult returns an optional accesslist
// Its the result of the `debug_createAccessList` RPC call.
// It contains an error if the transaction itself failed.
type accessListResult struct {
	Accesslist *types.AccessList `json:"accessList"`
	Error      string            `json:"error,omitempty"`
	GasUsed    hexutil.Uint64    `json:"gasUsed"`
}

// CreateAccessList creates a EIP-2930 type AccessList for the given transaction.
// Reexec and BlockNrOrHash can be specified to create the accessList on top of a certain state.
1323
func (s *PublicBlockChainAPI) CreateAccessList(ctx context.Context, args TransactionArgs, blockNrOrHash *rpc.BlockNumberOrHash) (*accessListResult, error) {
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
	bNrOrHash := rpc.BlockNumberOrHashWithNumber(rpc.PendingBlockNumber)
	if blockNrOrHash != nil {
		bNrOrHash = *blockNrOrHash
	}
	acl, gasUsed, vmerr, err := AccessList(ctx, s.b, bNrOrHash, args)
	if err != nil {
		return nil, err
	}
	result := &accessListResult{Accesslist: &acl, GasUsed: hexutil.Uint64(gasUsed)}
	if vmerr != nil {
		result.Error = vmerr.Error()
	}
	return result, nil
}

// AccessList creates an access list for the given transaction.
// If the accesslist creation fails an error is returned.
// If the transaction itself fails, an vmErr is returned.
1342
func AccessList(ctx context.Context, b Backend, blockNrOrHash rpc.BlockNumberOrHash, args TransactionArgs) (acl types.AccessList, gasUsed uint64, vmErr error, err error) {
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
	// Retrieve the execution context
	db, header, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
	if db == nil || err != nil {
		return nil, 0, nil, err
	}
	// If the gas amount is not set, extract this as it will depend on access
	// lists and we'll need to reestimate every time
	nogas := args.Gas == nil

	// Ensure any missing fields are filled, extract the recipient and input data
	if err := args.setDefaults(ctx, b); err != nil {
		return nil, 0, nil, err
	}
	var to common.Address
	if args.To != nil {
		to = *args.To
	} else {
1360
		to = crypto.CreateAddress(args.from(), uint64(*args.Nonce))
1361 1362 1363 1364 1365
	}
	// Retrieve the precompiles since they don't need to be added to the access list
	precompiles := vm.ActivePrecompiles(b.ChainConfig().Rules(header.Number))

	// Create an initial tracer
1366
	prevTracer := vm.NewAccessListTracer(nil, args.from(), to, precompiles)
1367
	if args.AccessList != nil {
1368
		prevTracer = vm.NewAccessListTracer(*args.AccessList, args.from(), to, precompiles)
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
	}
	for {
		// Retrieve the current access list to expand
		accessList := prevTracer.AccessList()
		log.Trace("Creating access list", "input", accessList)

		// If no gas amount was specified, each unique access list needs it's own
		// gas calculation. This is quite expensive, but we need to be accurate
		// and it's convered by the sender only anyway.
		if nogas {
			args.Gas = nil
			if err := args.setDefaults(ctx, b); err != nil {
				return nil, 0, nil, err // shouldn't happen, just in case
			}
		}
		// Copy the original db so we don't modify it
		statedb := db.Copy()
1386
		msg := types.NewMessage(args.from(), args.To, uint64(*args.Nonce), args.Value.ToInt(), uint64(*args.Gas), args.GasPrice.ToInt(), nil, nil, args.data(), accessList, false)
1387 1388

		// Apply the transaction with the access list tracer
1389
		tracer := vm.NewAccessListTracer(accessList, args.from(), to, precompiles)
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
		config := vm.Config{Tracer: tracer, Debug: true}
		vmenv, _, err := b.GetEVM(ctx, msg, statedb, header, &config)
		if err != nil {
			return nil, 0, nil, err
		}
		res, err := core.ApplyMessage(vmenv, msg, new(core.GasPool).AddGas(msg.Gas()))
		if err != nil {
			return nil, 0, nil, fmt.Errorf("failed to apply transaction: %v err: %v", args.toTransaction().Hash(), err)
		}
		if tracer.Equal(prevTracer) {
			return accessList, res.UsedGas, res.Err, nil
		}
		prevTracer = tracer
	}
}

1406 1407
// PublicTransactionPoolAPI exposes methods for the RPC interface
type PublicTransactionPoolAPI struct {
1408 1409
	b         Backend
	nonceLock *AddrLocker
1410
	signer    types.Signer
1411 1412 1413
}

// NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
1414
func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI {
1415 1416 1417 1418
	// The signer used by the API should always be the 'latest' known one because we expect
	// signers to be backwards-compatible with old transactions.
	signer := types.LatestSigner(b.ChainConfig())
	return &PublicTransactionPoolAPI{b, nonceLock, signer}
1419 1420 1421
}

// GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
1422
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
1423
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
1424 1425
		n := hexutil.Uint(len(block.Transactions()))
		return &n
1426 1427 1428 1429 1430
	}
	return nil
}

// GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
1431
func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
1432
	if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
1433 1434
		n := hexutil.Uint(len(block.Transactions()))
		return &n
1435 1436 1437 1438 1439
	}
	return nil
}

// GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
1440
func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
1441
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
1442
		return newRPCTransactionFromBlockIndex(block, uint64(index))
1443
	}
1444
	return nil
1445 1446 1447
}

// GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
1448
func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
1449
	if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
1450
		return newRPCTransactionFromBlockIndex(block, uint64(index))
1451
	}
1452
	return nil
1453 1454
}

1455
// GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
1456
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
1457
	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
1458
		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
1459
	}
1460
	return nil
1461 1462 1463
}

// GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
1464
func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
1465
	if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
1466
		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
1467
	}
1468
	return nil
1469 1470
}

1471
// GetTransactionCount returns the number of transactions the given address has sent for the given block number
1472
func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (*hexutil.Uint64, error) {
1473
	// Ask transaction pool for the nonce which includes pending transactions
1474
	if blockNr, ok := blockNrOrHash.Number(); ok && blockNr == rpc.PendingBlockNumber {
1475 1476 1477 1478 1479 1480 1481
		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
1482
	state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
1483 1484 1485
	if state == nil || err != nil {
		return nil, err
	}
1486 1487
	nonce := state.GetNonce(address)
	return (*hexutil.Uint64)(&nonce), state.Error()
1488 1489 1490
}

// GetTransactionByHash returns the transaction for the given hash
1491
func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) (*RPCTransaction, error) {
1492
	// Try to return an already finalized transaction
1493 1494 1495 1496 1497
	tx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash)
	if err != nil {
		return nil, err
	}
	if tx != nil {
1498 1499 1500 1501 1502
		header, err := s.b.HeaderByHash(ctx, blockHash)
		if err != nil {
			return nil, err
		}
		return newRPCTransaction(tx, blockHash, blockNumber, index, header.BaseFee), nil
1503
	}
1504 1505
	// No finalized transaction, try to retrieve it from the pool
	if tx := s.b.GetPoolTransaction(hash); tx != nil {
1506
		return newRPCPendingTransaction(tx, s.b.CurrentHeader(), s.b.ChainConfig()), nil
1507
	}
1508

1509
	// Transaction unknown, return as such
1510
	return nil, nil
1511 1512
}

1513
// GetRawTransactionByHash returns the bytes of the transaction for the given hash.
1514
func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
1515
	// Retrieve a finalized transaction, or a pooled otherwise
1516 1517 1518 1519 1520
	tx, _, _, _, err := s.b.GetTransaction(ctx, hash)
	if err != nil {
		return nil, err
	}
	if tx == nil {
1521 1522 1523 1524
		if tx = s.b.GetPoolTransaction(hash); tx == nil {
			// Transaction not found anywhere, abort
			return nil, nil
		}
1525
	}
1526
	// Serialize to RLP and return
1527
	return tx.MarshalBinary()
1528 1529
}

1530
// GetTransactionReceipt returns the transaction receipt for the given transaction hash.
1531
func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {
1532 1533
	tx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash)
	if err != nil {
1534
		return nil, nil
1535
	}
1536 1537 1538 1539 1540
	receipts, err := s.b.GetReceipts(ctx, blockHash)
	if err != nil {
		return nil, err
	}
	if len(receipts) <= int(index) {
1541
		return nil, nil
1542
	}
1543
	receipt := receipts[index]
1544

1545 1546 1547
	// Derive the sender.
	bigblock := new(big.Int).SetUint64(blockNumber)
	signer := types.MakeSigner(s.b.ChainConfig(), bigblock)
1548
	from, _ := types.Sender(signer, tx)
1549 1550

	fields := map[string]interface{}{
1551 1552
		"blockHash":         blockHash,
		"blockNumber":       hexutil.Uint64(blockNumber),
1553
		"transactionHash":   hash,
1554
		"transactionIndex":  hexutil.Uint64(index),
1555 1556
		"from":              from,
		"to":                tx.To(),
1557 1558
		"gasUsed":           hexutil.Uint64(receipt.GasUsed),
		"cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed),
1559 1560
		"contractAddress":   nil,
		"logs":              receipt.Logs,
1561
		"logsBloom":         receipt.Bloom,
1562
		"type":              hexutil.Uint(tx.Type()),
1563
	}
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574
	// Assign the effective gas price paid
	if !s.b.ChainConfig().IsLondon(bigblock) {
		fields["effectiveGasPrice"] = hexutil.Uint64(tx.GasPrice().Uint64())
	} else {
		header, err := s.b.HeaderByHash(ctx, blockHash)
		if err != nil {
			return nil, err
		}
		gasPrice := new(big.Int).Add(header.BaseFee, tx.EffectiveGasTipValue(header.BaseFee))
		fields["effectiveGasPrice"] = hexutil.Uint64(gasPrice.Uint64())
	}
1575 1576 1577 1578
	// Assign receipt status or post state.
	if len(receipt.PostState) > 0 {
		fields["root"] = hexutil.Bytes(receipt.PostState)
	} else {
1579
		fields["status"] = hexutil.Uint(receipt.Status)
1580
	}
1581
	if receipt.Logs == nil {
1582
		fields["logs"] = [][]*types.Log{}
1583 1584
	}
	// If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
1585
	if receipt.ContractAddress != (common.Address{}) {
1586 1587 1588 1589 1590 1591 1592
		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) {
1593 1594 1595 1596 1597 1598 1599 1600
	// 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
1601
	return wallet.SignTx(account, tx, s.b.ChainConfig().ChainID)
1602 1603
}

1604 1605
// 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) {
1606 1607
	// If the transaction fee cap is already specified, ensure the
	// fee of the given transaction is _reasonable_.
1608 1609
	if err := checkTxFee(tx.GasPrice(), tx.Gas(), b.RPCTxFeeCap()); err != nil {
		return common.Hash{}, err
1610
	}
1611 1612 1613 1614
	if !b.UnprotectedAllowed() && !tx.Protected() {
		// Ensure only eip155 signed transactions are submitted if EIP155Required is set.
		return common.Hash{}, errors.New("only replay-protected (EIP-155) transactions allowed over RPC")
	}
1615
	if err := b.SendTx(ctx, tx); err != nil {
1616 1617
		return common.Hash{}, err
	}
1618 1619 1620 1621 1622 1623 1624
	// Print a log with full tx details for manual investigations and interventions
	signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
	from, err := types.Sender(signer, tx)
	if err != nil {
		return common.Hash{}, err
	}

1625 1626
	if tx.To() == nil {
		addr := crypto.CreateAddress(from, tx.Nonce())
1627
		log.Info("Submitted contract creation", "hash", tx.Hash().Hex(), "from", from, "nonce", tx.Nonce(), "contract", addr.Hex(), "value", tx.Value())
1628
	} else {
1629
		log.Info("Submitted transaction", "hash", tx.Hash().Hex(), "from", from, "nonce", tx.Nonce(), "recipient", tx.To(), "value", tx.Value())
1630
	}
1631
	return tx.Hash(), nil
1632 1633 1634 1635
}

// SendTransaction creates a transaction for the given argument, sign it and submit it to the
// transaction pool.
1636
func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args TransactionArgs) (common.Hash, error) {
1637
	// Look up the wallet containing the requested signer
1638
	account := accounts.Account{Address: args.from()}
1639 1640 1641 1642 1643

	wallet, err := s.b.AccountManager().Find(account)
	if err != nil {
		return common.Hash{}, err
	}
1644 1645 1646 1647

	if args.Nonce == nil {
		// Hold the addresse's mutex around signing to prevent concurrent assignment of
		// the same nonce to multiple accounts.
1648 1649
		s.nonceLock.LockAddr(args.from())
		defer s.nonceLock.UnlockAddr(args.from())
1650 1651 1652 1653 1654 1655
	}

	// Set some sanity defaults and terminate on failure
	if err := args.setDefaults(ctx, s.b); err != nil {
		return common.Hash{}, err
	}
1656
	// Assemble the transaction and sign with the wallet
1657
	tx := args.toTransaction()
1658

1659
	signed, err := wallet.SignTx(account, tx, s.b.ChainConfig().ChainID)
1660 1661 1662
	if err != nil {
		return common.Hash{}, err
	}
1663
	return SubmitTransaction(ctx, s.b, signed)
1664 1665
}

1666 1667
// FillTransaction fills the defaults (nonce, gas, gasPrice) on a given unsigned transaction,
// and returns it to the caller for further processing (signing + broadcast)
1668
func (s *PublicTransactionPoolAPI) FillTransaction(ctx context.Context, args TransactionArgs) (*SignTransactionResult, error) {
1669 1670 1671 1672 1673 1674
	// 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()
1675
	data, err := tx.MarshalBinary()
1676 1677 1678 1679 1680 1681
	if err != nil {
		return nil, err
	}
	return &SignTransactionResult{data, tx}, nil
}

1682 1683
// SendRawTransaction will add the signed transaction to the transaction pool.
// The sender is responsible for signing the transaction and using the correct nonce.
1684
func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, input hexutil.Bytes) (common.Hash, error) {
1685
	tx := new(types.Transaction)
1686
	if err := tx.UnmarshalBinary(input); err != nil {
1687
		return common.Hash{}, err
1688
	}
1689
	return SubmitTransaction(ctx, s.b, tx)
1690 1691
}

1692 1693 1694
// Sign calculates an ECDSA signature for:
// keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
//
1695 1696 1697
// 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.
//
1698 1699 1700
// The account associated with addr must be unlocked.
//
// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
1701
func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
1702 1703 1704 1705 1706 1707 1708 1709
	// 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
1710
	signature, err := wallet.SignText(account, data)
1711
	if err == nil {
1712
		signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
1713 1714
	}
	return signature, err
1715 1716 1717 1718
}

// SignTransactionResult represents a RLP encoded signed transaction.
type SignTransactionResult struct {
1719 1720
	Raw hexutil.Bytes      `json:"raw"`
	Tx  *types.Transaction `json:"tx"`
1721 1722 1723 1724 1725
}

// 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.
1726
func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args TransactionArgs) (*SignTransactionResult, error) {
1727 1728 1729 1730 1731 1732
	if args.Gas == nil {
		return nil, fmt.Errorf("gas not specified")
	}
	if args.GasPrice == nil {
		return nil, fmt.Errorf("gasPrice not specified")
	}
1733
	if args.Nonce == nil {
1734
		return nil, fmt.Errorf("nonce not specified")
1735
	}
1736 1737
	if err := args.setDefaults(ctx, s.b); err != nil {
		return nil, err
1738
	}
1739 1740 1741 1742
	// Before actually sign the transaction, ensure the transaction fee is reasonable.
	if err := checkTxFee(args.GasPrice.ToInt(), uint64(*args.Gas), s.b.RPCTxFeeCap()); err != nil {
		return nil, err
	}
1743
	tx, err := s.sign(args.from(), args.toTransaction())
1744 1745 1746
	if err != nil {
		return nil, err
	}
1747
	data, err := tx.MarshalBinary()
1748 1749 1750
	if err != nil {
		return nil, err
	}
1751
	return &SignTransactionResult{data, tx}, nil
1752 1753
}

1754 1755
// PendingTransactions returns the transactions that are in the transaction pool
// and have a from address that is one of the accounts this node manages.
1756 1757 1758 1759 1760
func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return nil, err
	}
1761 1762 1763 1764 1765 1766
	accounts := make(map[common.Address]struct{})
	for _, wallet := range s.b.AccountManager().Wallets() {
		for _, account := range wallet.Accounts() {
			accounts[account.Address] = struct{}{}
		}
	}
1767
	curHeader := s.b.CurrentHeader()
1768 1769
	transactions := make([]*RPCTransaction, 0, len(pending))
	for _, tx := range pending {
1770
		from, _ := types.Sender(s.signer, tx)
1771
		if _, exists := accounts[from]; exists {
1772
			transactions = append(transactions, newRPCPendingTransaction(tx, curHeader, s.b.ChainConfig()))
1773 1774
		}
	}
1775
	return transactions, nil
1776 1777
}

1778 1779
// 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.
1780
func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs TransactionArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {
1781 1782 1783 1784 1785 1786 1787
	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()
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801

	// Before replacing the old transaction, ensure the _new_ transaction fee is reasonable.
	var price = matchTx.GasPrice()
	if gasPrice != nil {
		price = gasPrice.ToInt()
	}
	var gas = matchTx.Gas()
	if gasLimit != nil {
		gas = uint64(*gasLimit)
	}
	if err := checkTxFee(price, gas, s.b.RPCTxFeeCap()); err != nil {
		return common.Hash{}, err
	}
	// Iterate the pending list for replacement
1802 1803 1804 1805
	pending, err := s.b.GetPoolTransactions()
	if err != nil {
		return common.Hash{}, err
	}
1806
	for _, p := range pending {
1807 1808
		wantSigHash := s.signer.Hash(matchTx)
		pFrom, err := types.Sender(s.signer, p)
1809
		if err == nil && pFrom == sendArgs.from() && s.signer.Hash(p) == wantSigHash {
1810
			// Match. Re-sign and send the transaction.
1811
			if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 {
1812
				sendArgs.GasPrice = gasPrice
1813
			}
1814
			if gasLimit != nil && *gasLimit != 0 {
1815
				sendArgs.Gas = gasLimit
1816
			}
1817
			signedTx, err := s.sign(sendArgs.from(), sendArgs.toTransaction())
1818 1819 1820 1821 1822 1823 1824 1825 1826
			if err != nil {
				return common.Hash{}, err
			}
			if err = s.b.SendTx(ctx, signedTx); err != nil {
				return common.Hash{}, err
			}
			return signedTx.Hash(), nil
		}
	}
1827
	return common.Hash{}, fmt.Errorf("transaction %#x not found", matchTx.Hash())
1828 1829
}

1830
// PublicDebugAPI is the collection of Ethereum APIs exposed over the public
1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854
// 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
}

1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893
// 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
}

1894 1895 1896 1897 1898 1899
// 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)
	}
1900
	return spew.Sdump(block), nil
1901 1902 1903 1904 1905 1906 1907 1908
}

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

1912
// PrivateDebugAPI is the collection of Ethereum APIs exposed over the private
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923
// 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}
}

1924
// ChaindbProperty returns leveldb properties of the key-value database.
1925 1926 1927 1928 1929 1930
func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) {
	if property == "" {
		property = "leveldb.stats"
	} else if !strings.HasPrefix(property, "leveldb.") {
		property = "leveldb." + property
	}
1931
	return api.b.ChainDb().Stat(property)
1932 1933
}

1934 1935
// ChaindbCompact flattens the entire key-value database into a single level,
// removing all unused slots and merging all keys.
1936 1937
func (api *PrivateDebugAPI) ChaindbCompact() error {
	for b := byte(0); b < 255; b++ {
1938
		log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
1939
		if err := api.b.ChainDb().Compact([]byte{b}, []byte{b + 1}); err != nil {
1940
			log.Error("Database compaction failed", "err", err)
1941 1942 1943 1944 1945 1946
			return err
		}
	}
	return nil
}

1947
// SetHead rewinds the head of the blockchain to a previous block.
1948 1949
func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
	api.b.SetHead(uint64(number))
1950 1951 1952 1953
}

// PublicNetAPI offers network related RPC methods
type PublicNetAPI struct {
1954 1955
	net            *p2p.Server
	networkVersion uint64
1956 1957 1958
}

// NewPublicNetAPI creates a new net API instance.
1959 1960
func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
	return &PublicNetAPI{net, networkVersion}
1961 1962 1963 1964 1965 1966 1967 1968
}

// 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
1969 1970
func (s *PublicNetAPI) PeerCount() hexutil.Uint {
	return hexutil.Uint(s.net.PeerCount())
1971 1972
}

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

1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991
// checkTxFee is an internal function used to check whether the fee of
// the given transaction is _reasonable_(under the cap).
func checkTxFee(gasPrice *big.Int, gas uint64, cap float64) error {
	// Short circuit if there is no cap for transaction fee at all.
	if cap == 0 {
		return nil
	}
	feeEth := new(big.Float).Quo(new(big.Float).SetInt(new(big.Int).Mul(gasPrice, new(big.Int).SetUint64(gas))), new(big.Float).SetInt(big.NewInt(params.Ether)))
	feeFloat, _ := feeEth.Float64()
	if feeFloat > cap {
		return fmt.Errorf("tx fee (%.2f ether) exceeds the configured cap (%.2f ether)", feeFloat, cap)
	}
	return nil
}
1992 1993 1994 1995 1996 1997 1998 1999 2000

// toHexSlice creates a slice of hex-strings based on []byte.
func toHexSlice(b [][]byte) []string {
	r := make([]string, len(b))
	for i := range b {
		r[i] = hexutil.Encode(b[i])
	}
	return r
}