github.com/eliasnaur/go-ethereum@v1.6.8-0.20170717120422-6e13bd050756/internal/ethapi/api.go (about)

     1  // Copyright 2015 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package ethapi
    18  
    19  import (
    20  	"context"
    21  	"errors"
    22  	"fmt"
    23  	"math/big"
    24  	"strings"
    25  	"time"
    26  
    27  	"github.com/ethereum/go-ethereum/accounts"
    28  	"github.com/ethereum/go-ethereum/accounts/keystore"
    29  	"github.com/ethereum/go-ethereum/common"
    30  	"github.com/ethereum/go-ethereum/common/hexutil"
    31  	"github.com/ethereum/go-ethereum/common/math"
    32  	"github.com/ethereum/go-ethereum/consensus/ethash"
    33  	"github.com/ethereum/go-ethereum/core"
    34  	"github.com/ethereum/go-ethereum/core/types"
    35  	"github.com/ethereum/go-ethereum/core/vm"
    36  	"github.com/ethereum/go-ethereum/crypto"
    37  	"github.com/ethereum/go-ethereum/log"
    38  	"github.com/ethereum/go-ethereum/p2p"
    39  	"github.com/ethereum/go-ethereum/params"
    40  	"github.com/ethereum/go-ethereum/rlp"
    41  	"github.com/ethereum/go-ethereum/rpc"
    42  	"github.com/syndtr/goleveldb/leveldb"
    43  	"github.com/syndtr/goleveldb/leveldb/util"
    44  )
    45  
    46  const (
    47  	defaultGas      = 90000
    48  	defaultGasPrice = 50 * params.Shannon
    49  	emptyHex        = "0x"
    50  )
    51  
    52  // PublicEthereumAPI provides an API to access Ethereum related information.
    53  // It offers only methods that operate on public data that is freely available to anyone.
    54  type PublicEthereumAPI struct {
    55  	b Backend
    56  }
    57  
    58  // NewPublicEthereumAPI creates a new Etheruem protocol API.
    59  func NewPublicEthereumAPI(b Backend) *PublicEthereumAPI {
    60  	return &PublicEthereumAPI{b}
    61  }
    62  
    63  // GasPrice returns a suggestion for a gas price.
    64  func (s *PublicEthereumAPI) GasPrice(ctx context.Context) (*big.Int, error) {
    65  	return s.b.SuggestPrice(ctx)
    66  }
    67  
    68  // ProtocolVersion returns the current Ethereum protocol version this node supports
    69  func (s *PublicEthereumAPI) ProtocolVersion() hexutil.Uint {
    70  	return hexutil.Uint(s.b.ProtocolVersion())
    71  }
    72  
    73  // Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not
    74  // yet received the latest block headers from its pears. In case it is synchronizing:
    75  // - startingBlock: block number this node started to synchronise from
    76  // - currentBlock:  block number this node is currently importing
    77  // - highestBlock:  block number of the highest block header this node has received from peers
    78  // - pulledStates:  number of state entries processed until now
    79  // - knownStates:   number of known state entries that still need to be pulled
    80  func (s *PublicEthereumAPI) Syncing() (interface{}, error) {
    81  	progress := s.b.Downloader().Progress()
    82  
    83  	// Return not syncing if the synchronisation already completed
    84  	if progress.CurrentBlock >= progress.HighestBlock {
    85  		return false, nil
    86  	}
    87  	// Otherwise gather the block sync stats
    88  	return map[string]interface{}{
    89  		"startingBlock": hexutil.Uint64(progress.StartingBlock),
    90  		"currentBlock":  hexutil.Uint64(progress.CurrentBlock),
    91  		"highestBlock":  hexutil.Uint64(progress.HighestBlock),
    92  		"pulledStates":  hexutil.Uint64(progress.PulledStates),
    93  		"knownStates":   hexutil.Uint64(progress.KnownStates),
    94  	}, nil
    95  }
    96  
    97  // PublicTxPoolAPI offers and API for the transaction pool. It only operates on data that is non confidential.
    98  type PublicTxPoolAPI struct {
    99  	b Backend
   100  }
   101  
   102  // NewPublicTxPoolAPI creates a new tx pool service that gives information about the transaction pool.
   103  func NewPublicTxPoolAPI(b Backend) *PublicTxPoolAPI {
   104  	return &PublicTxPoolAPI{b}
   105  }
   106  
   107  // Content returns the transactions contained within the transaction pool.
   108  func (s *PublicTxPoolAPI) Content() map[string]map[string]map[string]*RPCTransaction {
   109  	content := map[string]map[string]map[string]*RPCTransaction{
   110  		"pending": make(map[string]map[string]*RPCTransaction),
   111  		"queued":  make(map[string]map[string]*RPCTransaction),
   112  	}
   113  	pending, queue := s.b.TxPoolContent()
   114  
   115  	// Flatten the pending transactions
   116  	for account, txs := range pending {
   117  		dump := make(map[string]*RPCTransaction)
   118  		for _, tx := range txs {
   119  			dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx)
   120  		}
   121  		content["pending"][account.Hex()] = dump
   122  	}
   123  	// Flatten the queued transactions
   124  	for account, txs := range queue {
   125  		dump := make(map[string]*RPCTransaction)
   126  		for _, tx := range txs {
   127  			dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx)
   128  		}
   129  		content["queued"][account.Hex()] = dump
   130  	}
   131  	return content
   132  }
   133  
   134  // Status returns the number of pending and queued transaction in the pool.
   135  func (s *PublicTxPoolAPI) Status() map[string]hexutil.Uint {
   136  	pending, queue := s.b.Stats()
   137  	return map[string]hexutil.Uint{
   138  		"pending": hexutil.Uint(pending),
   139  		"queued":  hexutil.Uint(queue),
   140  	}
   141  }
   142  
   143  // Inspect retrieves the content of the transaction pool and flattens it into an
   144  // easily inspectable list.
   145  func (s *PublicTxPoolAPI) Inspect() map[string]map[string]map[string]string {
   146  	content := map[string]map[string]map[string]string{
   147  		"pending": make(map[string]map[string]string),
   148  		"queued":  make(map[string]map[string]string),
   149  	}
   150  	pending, queue := s.b.TxPoolContent()
   151  
   152  	// Define a formatter to flatten a transaction into a string
   153  	var format = func(tx *types.Transaction) string {
   154  		if to := tx.To(); to != nil {
   155  			return fmt.Sprintf("%s: %v wei + %v × %v gas", tx.To().Hex(), tx.Value(), tx.Gas(), tx.GasPrice())
   156  		}
   157  		return fmt.Sprintf("contract creation: %v wei + %v × %v gas", tx.Value(), tx.Gas(), tx.GasPrice())
   158  	}
   159  	// Flatten the pending transactions
   160  	for account, txs := range pending {
   161  		dump := make(map[string]string)
   162  		for _, tx := range txs {
   163  			dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx)
   164  		}
   165  		content["pending"][account.Hex()] = dump
   166  	}
   167  	// Flatten the queued transactions
   168  	for account, txs := range queue {
   169  		dump := make(map[string]string)
   170  		for _, tx := range txs {
   171  			dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx)
   172  		}
   173  		content["queued"][account.Hex()] = dump
   174  	}
   175  	return content
   176  }
   177  
   178  // PublicAccountAPI provides an API to access accounts managed by this node.
   179  // It offers only methods that can retrieve accounts.
   180  type PublicAccountAPI struct {
   181  	am *accounts.Manager
   182  }
   183  
   184  // NewPublicAccountAPI creates a new PublicAccountAPI.
   185  func NewPublicAccountAPI(am *accounts.Manager) *PublicAccountAPI {
   186  	return &PublicAccountAPI{am: am}
   187  }
   188  
   189  // Accounts returns the collection of accounts this node manages
   190  func (s *PublicAccountAPI) Accounts() []common.Address {
   191  	addresses := make([]common.Address, 0) // return [] instead of nil if empty
   192  	for _, wallet := range s.am.Wallets() {
   193  		for _, account := range wallet.Accounts() {
   194  			addresses = append(addresses, account.Address)
   195  		}
   196  	}
   197  	return addresses
   198  }
   199  
   200  // PrivateAccountAPI provides an API to access accounts managed by this node.
   201  // It offers methods to create, (un)lock en list accounts. Some methods accept
   202  // passwords and are therefore considered private by default.
   203  type PrivateAccountAPI struct {
   204  	am        *accounts.Manager
   205  	nonceLock *AddrLocker
   206  	b         Backend
   207  }
   208  
   209  // NewPrivateAccountAPI create a new PrivateAccountAPI.
   210  func NewPrivateAccountAPI(b Backend, nonceLock *AddrLocker) *PrivateAccountAPI {
   211  	return &PrivateAccountAPI{
   212  		am:        b.AccountManager(),
   213  		nonceLock: nonceLock,
   214  		b:         b,
   215  	}
   216  }
   217  
   218  // ListAccounts will return a list of addresses for accounts this node manages.
   219  func (s *PrivateAccountAPI) ListAccounts() []common.Address {
   220  	addresses := make([]common.Address, 0) // return [] instead of nil if empty
   221  	for _, wallet := range s.am.Wallets() {
   222  		for _, account := range wallet.Accounts() {
   223  			addresses = append(addresses, account.Address)
   224  		}
   225  	}
   226  	return addresses
   227  }
   228  
   229  // rawWallet is a JSON representation of an accounts.Wallet interface, with its
   230  // data contents extracted into plain fields.
   231  type rawWallet struct {
   232  	URL      string             `json:"url"`
   233  	Status   string             `json:"status"`
   234  	Accounts []accounts.Account `json:"accounts"`
   235  }
   236  
   237  // ListWallets will return a list of wallets this node manages.
   238  func (s *PrivateAccountAPI) ListWallets() []rawWallet {
   239  	wallets := make([]rawWallet, 0) // return [] instead of nil if empty
   240  	for _, wallet := range s.am.Wallets() {
   241  		wallets = append(wallets, rawWallet{
   242  			URL:      wallet.URL().String(),
   243  			Status:   wallet.Status(),
   244  			Accounts: wallet.Accounts(),
   245  		})
   246  	}
   247  	return wallets
   248  }
   249  
   250  // DeriveAccount requests a HD wallet to derive a new account, optionally pinning
   251  // it for later reuse.
   252  func (s *PrivateAccountAPI) DeriveAccount(url string, path string, pin *bool) (accounts.Account, error) {
   253  	wallet, err := s.am.Wallet(url)
   254  	if err != nil {
   255  		return accounts.Account{}, err
   256  	}
   257  	derivPath, err := accounts.ParseDerivationPath(path)
   258  	if err != nil {
   259  		return accounts.Account{}, err
   260  	}
   261  	if pin == nil {
   262  		pin = new(bool)
   263  	}
   264  	return wallet.Derive(derivPath, *pin)
   265  }
   266  
   267  // NewAccount will create a new account and returns the address for the new account.
   268  func (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) {
   269  	acc, err := fetchKeystore(s.am).NewAccount(password)
   270  	if err == nil {
   271  		return acc.Address, nil
   272  	}
   273  	return common.Address{}, err
   274  }
   275  
   276  // fetchKeystore retrives the encrypted keystore from the account manager.
   277  func fetchKeystore(am *accounts.Manager) *keystore.KeyStore {
   278  	return am.Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
   279  }
   280  
   281  // ImportRawKey stores the given hex encoded ECDSA key into the key directory,
   282  // encrypting it with the passphrase.
   283  func (s *PrivateAccountAPI) ImportRawKey(privkey string, password string) (common.Address, error) {
   284  	key, err := crypto.HexToECDSA(privkey)
   285  	if err != nil {
   286  		return common.Address{}, err
   287  	}
   288  	acc, err := fetchKeystore(s.am).ImportECDSA(key, password)
   289  	return acc.Address, err
   290  }
   291  
   292  // UnlockAccount will unlock the account associated with the given address with
   293  // the given password for duration seconds. If duration is nil it will use a
   294  // default of 300 seconds. It returns an indication if the account was unlocked.
   295  func (s *PrivateAccountAPI) UnlockAccount(addr common.Address, password string, duration *uint64) (bool, error) {
   296  	const max = uint64(time.Duration(math.MaxInt64) / time.Second)
   297  	var d time.Duration
   298  	if duration == nil {
   299  		d = 300 * time.Second
   300  	} else if *duration > max {
   301  		return false, errors.New("unlock duration too large")
   302  	} else {
   303  		d = time.Duration(*duration) * time.Second
   304  	}
   305  	err := fetchKeystore(s.am).TimedUnlock(accounts.Account{Address: addr}, password, d)
   306  	return err == nil, err
   307  }
   308  
   309  // LockAccount will lock the account associated with the given address when it's unlocked.
   310  func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool {
   311  	return fetchKeystore(s.am).Lock(addr) == nil
   312  }
   313  
   314  // SendTransaction will create a transaction from the given arguments and
   315  // tries to sign it with the key associated with args.To. If the given passwd isn't
   316  // able to decrypt the key it fails.
   317  func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
   318  	// Look up the wallet containing the requested signer
   319  	account := accounts.Account{Address: args.From}
   320  
   321  	wallet, err := s.am.Find(account)
   322  	if err != nil {
   323  		return common.Hash{}, err
   324  	}
   325  
   326  	if args.Nonce == nil {
   327  		// Hold the addresse's mutex around signing to prevent concurrent assignment of
   328  		// the same nonce to multiple accounts.
   329  		s.nonceLock.LockAddr(args.From)
   330  		defer s.nonceLock.UnlockAddr(args.From)
   331  	}
   332  
   333  	// Set some sanity defaults and terminate on failure
   334  	if err := args.setDefaults(ctx, s.b); err != nil {
   335  		return common.Hash{}, err
   336  	}
   337  	// Assemble the transaction and sign with the wallet
   338  	tx := args.toTransaction()
   339  
   340  	var chainID *big.Int
   341  	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
   342  		chainID = config.ChainId
   343  	}
   344  	signed, err := wallet.SignTxWithPassphrase(account, passwd, tx, chainID)
   345  	if err != nil {
   346  		return common.Hash{}, err
   347  	}
   348  	return submitTransaction(ctx, s.b, signed)
   349  }
   350  
   351  // signHash is a helper function that calculates a hash for the given message that can be
   352  // safely used to calculate a signature from.
   353  //
   354  // The hash is calulcated as
   355  //   keccak256("\x19Ethereum Signed Message:\n"${message length}${message}).
   356  //
   357  // This gives context to the signed message and prevents signing of transactions.
   358  func signHash(data []byte) []byte {
   359  	msg := fmt.Sprintf("\x19Ethereum Signed Message:\n%d%s", len(data), data)
   360  	return crypto.Keccak256([]byte(msg))
   361  }
   362  
   363  // Sign calculates an Ethereum ECDSA signature for:
   364  // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message))
   365  //
   366  // Note, the produced signature conforms to the secp256k1 curve R, S and V values,
   367  // where the V value will be 27 or 28 for legacy reasons.
   368  //
   369  // The key used to calculate the signature is decrypted with the given password.
   370  //
   371  // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign
   372  func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {
   373  	// Look up the wallet containing the requested signer
   374  	account := accounts.Account{Address: addr}
   375  
   376  	wallet, err := s.b.AccountManager().Find(account)
   377  	if err != nil {
   378  		return nil, err
   379  	}
   380  	// Assemble sign the data with the wallet
   381  	signature, err := wallet.SignHashWithPassphrase(account, passwd, signHash(data))
   382  	if err != nil {
   383  		return nil, err
   384  	}
   385  	signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
   386  	return signature, nil
   387  }
   388  
   389  // EcRecover returns the address for the account that was used to create the signature.
   390  // Note, this function is compatible with eth_sign and personal_sign. As such it recovers
   391  // the address of:
   392  // hash = keccak256("\x19Ethereum Signed Message:\n"${message length}${message})
   393  // addr = ecrecover(hash, signature)
   394  //
   395  // Note, the signature must conform to the secp256k1 curve R, S and V values, where
   396  // the V value must be be 27 or 28 for legacy reasons.
   397  //
   398  // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover
   399  func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {
   400  	if len(sig) != 65 {
   401  		return common.Address{}, fmt.Errorf("signature must be 65 bytes long")
   402  	}
   403  	if sig[64] != 27 && sig[64] != 28 {
   404  		return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)")
   405  	}
   406  	sig[64] -= 27 // Transform yellow paper V from 27/28 to 0/1
   407  
   408  	rpk, err := crypto.Ecrecover(signHash(data), sig)
   409  	if err != nil {
   410  		return common.Address{}, err
   411  	}
   412  	pubKey := crypto.ToECDSAPub(rpk)
   413  	recoveredAddr := crypto.PubkeyToAddress(*pubKey)
   414  	return recoveredAddr, nil
   415  }
   416  
   417  // SignAndSendTransaction was renamed to SendTransaction. This method is deprecated
   418  // and will be removed in the future. It primary goal is to give clients time to update.
   419  func (s *PrivateAccountAPI) SignAndSendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
   420  	return s.SendTransaction(ctx, args, passwd)
   421  }
   422  
   423  // PublicBlockChainAPI provides an API to access the Ethereum blockchain.
   424  // It offers only methods that operate on public data that is freely available to anyone.
   425  type PublicBlockChainAPI struct {
   426  	b Backend
   427  }
   428  
   429  // NewPublicBlockChainAPI creates a new Etheruem blockchain API.
   430  func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI {
   431  	return &PublicBlockChainAPI{b}
   432  }
   433  
   434  // BlockNumber returns the block number of the chain head.
   435  func (s *PublicBlockChainAPI) BlockNumber() *big.Int {
   436  	header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available
   437  	return header.Number
   438  }
   439  
   440  // GetBalance returns the amount of wei for the given address in the state of the
   441  // given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta
   442  // block numbers are also allowed.
   443  func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*big.Int, error) {
   444  	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
   445  	if state == nil || err != nil {
   446  		return nil, err
   447  	}
   448  	b := state.GetBalance(address)
   449  	return b, state.Error()
   450  }
   451  
   452  // GetBlockByNumber returns the requested block. When blockNr is -1 the chain head is returned. When fullTx is true all
   453  // transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
   454  func (s *PublicBlockChainAPI) GetBlockByNumber(ctx context.Context, blockNr rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) {
   455  	block, err := s.b.BlockByNumber(ctx, blockNr)
   456  	if block != nil {
   457  		response, err := s.rpcOutputBlock(block, true, fullTx)
   458  		if err == nil && blockNr == rpc.PendingBlockNumber {
   459  			// Pending blocks need to nil out a few fields
   460  			for _, field := range []string{"hash", "nonce", "miner"} {
   461  				response[field] = nil
   462  			}
   463  		}
   464  		return response, err
   465  	}
   466  	return nil, err
   467  }
   468  
   469  // GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full
   470  // detail, otherwise only the transaction hash is returned.
   471  func (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, blockHash common.Hash, fullTx bool) (map[string]interface{}, error) {
   472  	block, err := s.b.GetBlock(ctx, blockHash)
   473  	if block != nil {
   474  		return s.rpcOutputBlock(block, true, fullTx)
   475  	}
   476  	return nil, err
   477  }
   478  
   479  // GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true
   480  // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
   481  func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {
   482  	block, err := s.b.BlockByNumber(ctx, blockNr)
   483  	if block != nil {
   484  		uncles := block.Uncles()
   485  		if index >= hexutil.Uint(len(uncles)) {
   486  			log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index)
   487  			return nil, nil
   488  		}
   489  		block = types.NewBlockWithHeader(uncles[index])
   490  		return s.rpcOutputBlock(block, false, false)
   491  	}
   492  	return nil, err
   493  }
   494  
   495  // GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true
   496  // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
   497  func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {
   498  	block, err := s.b.GetBlock(ctx, blockHash)
   499  	if block != nil {
   500  		uncles := block.Uncles()
   501  		if index >= hexutil.Uint(len(uncles)) {
   502  			log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index)
   503  			return nil, nil
   504  		}
   505  		block = types.NewBlockWithHeader(uncles[index])
   506  		return s.rpcOutputBlock(block, false, false)
   507  	}
   508  	return nil, err
   509  }
   510  
   511  // GetUncleCountByBlockNumber returns number of uncles in the block for the given block number
   512  func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
   513  	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
   514  		n := hexutil.Uint(len(block.Uncles()))
   515  		return &n
   516  	}
   517  	return nil
   518  }
   519  
   520  // GetUncleCountByBlockHash returns number of uncles in the block for the given block hash
   521  func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
   522  	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
   523  		n := hexutil.Uint(len(block.Uncles()))
   524  		return &n
   525  	}
   526  	return nil
   527  }
   528  
   529  // GetCode returns the code stored at the given address in the state for the given block number.
   530  func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
   531  	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
   532  	if state == nil || err != nil {
   533  		return nil, err
   534  	}
   535  	code := state.GetCode(address)
   536  	return code, state.Error()
   537  }
   538  
   539  // GetStorageAt returns the storage from the state at the given address, key and
   540  // block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block
   541  // numbers are also allowed.
   542  func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
   543  	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
   544  	if state == nil || err != nil {
   545  		return nil, err
   546  	}
   547  	res := state.GetState(address, common.HexToHash(key))
   548  	return res[:], state.Error()
   549  }
   550  
   551  // callmsg is the message type used for call transitions.
   552  type callmsg struct {
   553  	addr          common.Address
   554  	to            *common.Address
   555  	gas, gasPrice *big.Int
   556  	value         *big.Int
   557  	data          []byte
   558  }
   559  
   560  // accessor boilerplate to implement core.Message
   561  func (m callmsg) From() (common.Address, error)         { return m.addr, nil }
   562  func (m callmsg) FromFrontier() (common.Address, error) { return m.addr, nil }
   563  func (m callmsg) Nonce() uint64                         { return 0 }
   564  func (m callmsg) CheckNonce() bool                      { return false }
   565  func (m callmsg) To() *common.Address                   { return m.to }
   566  func (m callmsg) GasPrice() *big.Int                    { return m.gasPrice }
   567  func (m callmsg) Gas() *big.Int                         { return m.gas }
   568  func (m callmsg) Value() *big.Int                       { return m.value }
   569  func (m callmsg) Data() []byte                          { return m.data }
   570  
   571  // CallArgs represents the arguments for a call.
   572  type CallArgs struct {
   573  	From     common.Address  `json:"from"`
   574  	To       *common.Address `json:"to"`
   575  	Gas      hexutil.Big     `json:"gas"`
   576  	GasPrice hexutil.Big     `json:"gasPrice"`
   577  	Value    hexutil.Big     `json:"value"`
   578  	Data     hexutil.Bytes   `json:"data"`
   579  }
   580  
   581  func (s *PublicBlockChainAPI) doCall(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber, vmCfg vm.Config) ([]byte, *big.Int, error) {
   582  	defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now())
   583  
   584  	state, header, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
   585  	if state == nil || err != nil {
   586  		return nil, common.Big0, err
   587  	}
   588  	// Set sender address or use a default if none specified
   589  	addr := args.From
   590  	if addr == (common.Address{}) {
   591  		if wallets := s.b.AccountManager().Wallets(); len(wallets) > 0 {
   592  			if accounts := wallets[0].Accounts(); len(accounts) > 0 {
   593  				addr = accounts[0].Address
   594  			}
   595  		}
   596  	}
   597  	// Set default gas & gas price if none were set
   598  	gas, gasPrice := args.Gas.ToInt(), args.GasPrice.ToInt()
   599  	if gas.Sign() == 0 {
   600  		gas = big.NewInt(50000000)
   601  	}
   602  	if gasPrice.Sign() == 0 {
   603  		gasPrice = new(big.Int).SetUint64(defaultGasPrice)
   604  	}
   605  
   606  	// Create new call message
   607  	msg := types.NewMessage(addr, args.To, 0, args.Value.ToInt(), gas, gasPrice, args.Data, false)
   608  
   609  	// Setup context so it may be cancelled the call has completed
   610  	// or, in case of unmetered gas, setup a context with a timeout.
   611  	var cancel context.CancelFunc
   612  	if vmCfg.DisableGasMetering {
   613  		ctx, cancel = context.WithTimeout(ctx, time.Second*5)
   614  	} else {
   615  		ctx, cancel = context.WithCancel(ctx)
   616  	}
   617  	// Make sure the context is cancelled when the call has completed
   618  	// this makes sure resources are cleaned up.
   619  	defer func() { cancel() }()
   620  
   621  	// Get a new instance of the EVM.
   622  	evm, vmError, err := s.b.GetEVM(ctx, msg, state, header, vmCfg)
   623  	if err != nil {
   624  		return nil, common.Big0, err
   625  	}
   626  	// Wait for the context to be done and cancel the evm. Even if the
   627  	// EVM has finished, cancelling may be done (repeatedly)
   628  	go func() {
   629  		select {
   630  		case <-ctx.Done():
   631  			evm.Cancel()
   632  		}
   633  	}()
   634  
   635  	// Setup the gas pool (also for unmetered requests)
   636  	// and apply the message.
   637  	gp := new(core.GasPool).AddGas(math.MaxBig256)
   638  	res, gas, err := core.ApplyMessage(evm, msg, gp)
   639  	if err := vmError(); err != nil {
   640  		return nil, common.Big0, err
   641  	}
   642  	return res, gas, err
   643  }
   644  
   645  // Call executes the given transaction on the state for the given block number.
   646  // It doesn't make and changes in the state/blockchain and is useful to execute and retrieve values.
   647  func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
   648  	result, _, err := s.doCall(ctx, args, blockNr, vm.Config{DisableGasMetering: true})
   649  	return (hexutil.Bytes)(result), err
   650  }
   651  
   652  // EstimateGas returns an estimate of the amount of gas needed to execute the given transaction.
   653  func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (*hexutil.Big, error) {
   654  	// Binary search the gas requirement, as it may be higher than the amount used
   655  	var lo, hi uint64
   656  	if (*big.Int)(&args.Gas).Sign() != 0 {
   657  		hi = (*big.Int)(&args.Gas).Uint64()
   658  	} else {
   659  		// Retrieve the current pending block to act as the gas ceiling
   660  		block, err := s.b.BlockByNumber(ctx, rpc.PendingBlockNumber)
   661  		if err != nil {
   662  			return nil, err
   663  		}
   664  		hi = block.GasLimit().Uint64()
   665  	}
   666  	for lo+1 < hi {
   667  		// Take a guess at the gas, and check transaction validity
   668  		mid := (hi + lo) / 2
   669  		(*big.Int)(&args.Gas).SetUint64(mid)
   670  
   671  		_, gas, err := s.doCall(ctx, args, rpc.PendingBlockNumber, vm.Config{})
   672  
   673  		// If the transaction became invalid or used all the gas (failed), raise the gas limit
   674  		if err != nil || gas.Cmp((*big.Int)(&args.Gas)) == 0 {
   675  			lo = mid
   676  			continue
   677  		}
   678  		// Otherwise assume the transaction succeeded, lower the gas limit
   679  		hi = mid
   680  	}
   681  	return (*hexutil.Big)(new(big.Int).SetUint64(hi)), nil
   682  }
   683  
   684  // ExecutionResult groups all structured logs emitted by the EVM
   685  // while replaying a transaction in debug mode as well as the amount of
   686  // gas used and the return value
   687  type ExecutionResult struct {
   688  	Gas         *big.Int       `json:"gas"`
   689  	ReturnValue string         `json:"returnValue"`
   690  	StructLogs  []StructLogRes `json:"structLogs"`
   691  }
   692  
   693  // StructLogRes stores a structured log emitted by the EVM while replaying a
   694  // transaction in debug mode
   695  type StructLogRes struct {
   696  	Pc      uint64            `json:"pc"`
   697  	Op      string            `json:"op"`
   698  	Gas     uint64            `json:"gas"`
   699  	GasCost uint64            `json:"gasCost"`
   700  	Depth   int               `json:"depth"`
   701  	Error   error             `json:"error"`
   702  	Stack   []string          `json:"stack"`
   703  	Memory  []string          `json:"memory"`
   704  	Storage map[string]string `json:"storage"`
   705  }
   706  
   707  // formatLogs formats EVM returned structured logs for json output
   708  func FormatLogs(structLogs []vm.StructLog) []StructLogRes {
   709  	formattedStructLogs := make([]StructLogRes, len(structLogs))
   710  	for index, trace := range structLogs {
   711  		formattedStructLogs[index] = StructLogRes{
   712  			Pc:      trace.Pc,
   713  			Op:      trace.Op.String(),
   714  			Gas:     trace.Gas,
   715  			GasCost: trace.GasCost,
   716  			Depth:   trace.Depth,
   717  			Error:   trace.Err,
   718  			Stack:   make([]string, len(trace.Stack)),
   719  			Storage: make(map[string]string),
   720  		}
   721  
   722  		for i, stackValue := range trace.Stack {
   723  			formattedStructLogs[index].Stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32))
   724  		}
   725  
   726  		for i := 0; i+32 <= len(trace.Memory); i += 32 {
   727  			formattedStructLogs[index].Memory = append(formattedStructLogs[index].Memory, fmt.Sprintf("%x", trace.Memory[i:i+32]))
   728  		}
   729  
   730  		for i, storageValue := range trace.Storage {
   731  			formattedStructLogs[index].Storage[fmt.Sprintf("%x", i)] = fmt.Sprintf("%x", storageValue)
   732  		}
   733  	}
   734  	return formattedStructLogs
   735  }
   736  
   737  // rpcOutputBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are
   738  // returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain
   739  // transaction hashes.
   740  func (s *PublicBlockChainAPI) rpcOutputBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
   741  	head := b.Header() // copies the header once
   742  	fields := map[string]interface{}{
   743  		"number":           (*hexutil.Big)(head.Number),
   744  		"hash":             b.Hash(),
   745  		"parentHash":       head.ParentHash,
   746  		"nonce":            head.Nonce,
   747  		"mixHash":          head.MixDigest,
   748  		"sha3Uncles":       head.UncleHash,
   749  		"logsBloom":        head.Bloom,
   750  		"stateRoot":        head.Root,
   751  		"miner":            head.Coinbase,
   752  		"difficulty":       (*hexutil.Big)(head.Difficulty),
   753  		"totalDifficulty":  (*hexutil.Big)(s.b.GetTd(b.Hash())),
   754  		"extraData":        hexutil.Bytes(head.Extra),
   755  		"size":             hexutil.Uint64(uint64(b.Size().Int64())),
   756  		"gasLimit":         (*hexutil.Big)(head.GasLimit),
   757  		"gasUsed":          (*hexutil.Big)(head.GasUsed),
   758  		"timestamp":        (*hexutil.Big)(head.Time),
   759  		"transactionsRoot": head.TxHash,
   760  		"receiptsRoot":     head.ReceiptHash,
   761  	}
   762  
   763  	if inclTx {
   764  		formatTx := func(tx *types.Transaction) (interface{}, error) {
   765  			return tx.Hash(), nil
   766  		}
   767  
   768  		if fullTx {
   769  			formatTx = func(tx *types.Transaction) (interface{}, error) {
   770  				return newRPCTransactionFromBlockHash(b, tx.Hash()), nil
   771  			}
   772  		}
   773  
   774  		txs := b.Transactions()
   775  		transactions := make([]interface{}, len(txs))
   776  		var err error
   777  		for i, tx := range b.Transactions() {
   778  			if transactions[i], err = formatTx(tx); err != nil {
   779  				return nil, err
   780  			}
   781  		}
   782  		fields["transactions"] = transactions
   783  	}
   784  
   785  	uncles := b.Uncles()
   786  	uncleHashes := make([]common.Hash, len(uncles))
   787  	for i, uncle := range uncles {
   788  		uncleHashes[i] = uncle.Hash()
   789  	}
   790  	fields["uncles"] = uncleHashes
   791  
   792  	return fields, nil
   793  }
   794  
   795  // RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction
   796  type RPCTransaction struct {
   797  	BlockHash        common.Hash     `json:"blockHash"`
   798  	BlockNumber      *hexutil.Big    `json:"blockNumber"`
   799  	From             common.Address  `json:"from"`
   800  	Gas              *hexutil.Big    `json:"gas"`
   801  	GasPrice         *hexutil.Big    `json:"gasPrice"`
   802  	Hash             common.Hash     `json:"hash"`
   803  	Input            hexutil.Bytes   `json:"input"`
   804  	Nonce            hexutil.Uint64  `json:"nonce"`
   805  	To               *common.Address `json:"to"`
   806  	TransactionIndex hexutil.Uint    `json:"transactionIndex"`
   807  	Value            *hexutil.Big    `json:"value"`
   808  	V                *hexutil.Big    `json:"v"`
   809  	R                *hexutil.Big    `json:"r"`
   810  	S                *hexutil.Big    `json:"s"`
   811  }
   812  
   813  // newRPCTransaction returns a transaction that will serialize to the RPC
   814  // representation, with the given location metadata set (if available).
   815  func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64) *RPCTransaction {
   816  	var signer types.Signer = types.FrontierSigner{}
   817  	if tx.Protected() {
   818  		signer = types.NewEIP155Signer(tx.ChainId())
   819  	}
   820  	from, _ := types.Sender(signer, tx)
   821  	v, r, s := tx.RawSignatureValues()
   822  
   823  	result := &RPCTransaction{
   824  		From:     from,
   825  		Gas:      (*hexutil.Big)(tx.Gas()),
   826  		GasPrice: (*hexutil.Big)(tx.GasPrice()),
   827  		Hash:     tx.Hash(),
   828  		Input:    hexutil.Bytes(tx.Data()),
   829  		Nonce:    hexutil.Uint64(tx.Nonce()),
   830  		To:       tx.To(),
   831  		Value:    (*hexutil.Big)(tx.Value()),
   832  		V:        (*hexutil.Big)(v),
   833  		R:        (*hexutil.Big)(r),
   834  		S:        (*hexutil.Big)(s),
   835  	}
   836  	if blockHash != (common.Hash{}) {
   837  		result.BlockHash = blockHash
   838  		result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber))
   839  		result.TransactionIndex = hexutil.Uint(index)
   840  	}
   841  	return result
   842  }
   843  
   844  // newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation
   845  func newRPCPendingTransaction(tx *types.Transaction) *RPCTransaction {
   846  	return newRPCTransaction(tx, common.Hash{}, 0, 0)
   847  }
   848  
   849  // newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation.
   850  func newRPCTransactionFromBlockIndex(b *types.Block, index uint64) *RPCTransaction {
   851  	txs := b.Transactions()
   852  	if index >= uint64(len(txs)) {
   853  		return nil
   854  	}
   855  	return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index)
   856  }
   857  
   858  // newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index.
   859  func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes {
   860  	txs := b.Transactions()
   861  	if index >= uint64(len(txs)) {
   862  		return nil
   863  	}
   864  	blob, _ := rlp.EncodeToBytes(txs[index])
   865  	return blob
   866  }
   867  
   868  // newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
   869  func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction {
   870  	for idx, tx := range b.Transactions() {
   871  		if tx.Hash() == hash {
   872  			return newRPCTransactionFromBlockIndex(b, uint64(idx))
   873  		}
   874  	}
   875  	return nil
   876  }
   877  
   878  // PublicTransactionPoolAPI exposes methods for the RPC interface
   879  type PublicTransactionPoolAPI struct {
   880  	b         Backend
   881  	nonceLock *AddrLocker
   882  }
   883  
   884  // NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
   885  func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI {
   886  	return &PublicTransactionPoolAPI{b, nonceLock}
   887  }
   888  
   889  // GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
   890  func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
   891  	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
   892  		n := hexutil.Uint(len(block.Transactions()))
   893  		return &n
   894  	}
   895  	return nil
   896  }
   897  
   898  // GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
   899  func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
   900  	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
   901  		n := hexutil.Uint(len(block.Transactions()))
   902  		return &n
   903  	}
   904  	return nil
   905  }
   906  
   907  // GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
   908  func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
   909  	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
   910  		return newRPCTransactionFromBlockIndex(block, uint64(index))
   911  	}
   912  	return nil
   913  }
   914  
   915  // GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
   916  func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
   917  	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
   918  		return newRPCTransactionFromBlockIndex(block, uint64(index))
   919  	}
   920  	return nil
   921  }
   922  
   923  // GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
   924  func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
   925  	if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
   926  		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
   927  	}
   928  	return nil
   929  }
   930  
   931  // GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
   932  func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
   933  	if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
   934  		return newRPCRawTransactionFromBlockIndex(block, uint64(index))
   935  	}
   936  	return nil
   937  }
   938  
   939  // GetTransactionCount returns the number of transactions the given address has sent for the given block number
   940  func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) {
   941  	state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
   942  	if state == nil || err != nil {
   943  		return nil, err
   944  	}
   945  	nonce := state.GetNonce(address)
   946  	return (*hexutil.Uint64)(&nonce), state.Error()
   947  }
   948  
   949  // GetTransactionByHash returns the transaction for the given hash
   950  func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) *RPCTransaction {
   951  	// Try to return an already finalized transaction
   952  	if tx, blockHash, blockNumber, index := core.GetTransaction(s.b.ChainDb(), hash); tx != nil {
   953  		return newRPCTransaction(tx, blockHash, blockNumber, index)
   954  	}
   955  	// No finalized transaction, try to retrieve it from the pool
   956  	if tx := s.b.GetPoolTransaction(hash); tx != nil {
   957  		return newRPCPendingTransaction(tx)
   958  	}
   959  	// Transaction unknown, return as such
   960  	return nil
   961  }
   962  
   963  // GetRawTransactionByHash returns the bytes of the transaction for the given hash.
   964  func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
   965  	var tx *types.Transaction
   966  
   967  	// Retrieve a finalized transaction, or a pooled otherwise
   968  	if tx, _, _, _ = core.GetTransaction(s.b.ChainDb(), hash); tx == nil {
   969  		if tx = s.b.GetPoolTransaction(hash); tx == nil {
   970  			// Transaction not found anywhere, abort
   971  			return nil, nil
   972  		}
   973  	}
   974  	// Serialize to RLP and return
   975  	return rlp.EncodeToBytes(tx)
   976  }
   977  
   978  // GetTransactionReceipt returns the transaction receipt for the given transaction hash.
   979  func (s *PublicTransactionPoolAPI) GetTransactionReceipt(hash common.Hash) (map[string]interface{}, error) {
   980  	tx, blockHash, blockNumber, index := core.GetTransaction(s.b.ChainDb(), hash)
   981  	if tx == nil {
   982  		return nil, nil
   983  	}
   984  	receipt, _, _, _ := core.GetReceipt(s.b.ChainDb(), hash) // Old receipts don't have the lookup data available
   985  
   986  	var signer types.Signer = types.FrontierSigner{}
   987  	if tx.Protected() {
   988  		signer = types.NewEIP155Signer(tx.ChainId())
   989  	}
   990  	from, _ := types.Sender(signer, tx)
   991  
   992  	fields := map[string]interface{}{
   993  		"root":              hexutil.Bytes(receipt.PostState),
   994  		"blockHash":         blockHash,
   995  		"blockNumber":       hexutil.Uint64(blockNumber),
   996  		"transactionHash":   hash,
   997  		"transactionIndex":  hexutil.Uint64(index),
   998  		"from":              from,
   999  		"to":                tx.To(),
  1000  		"gasUsed":           (*hexutil.Big)(receipt.GasUsed),
  1001  		"cumulativeGasUsed": (*hexutil.Big)(receipt.CumulativeGasUsed),
  1002  		"contractAddress":   nil,
  1003  		"logs":              receipt.Logs,
  1004  		"logsBloom":         receipt.Bloom,
  1005  	}
  1006  	if receipt.Logs == nil {
  1007  		fields["logs"] = [][]*types.Log{}
  1008  	}
  1009  	// If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
  1010  	if receipt.ContractAddress != (common.Address{}) {
  1011  		fields["contractAddress"] = receipt.ContractAddress
  1012  	}
  1013  	return fields, nil
  1014  }
  1015  
  1016  // sign is a helper function that signs a transaction with the private key of the given address.
  1017  func (s *PublicTransactionPoolAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) {
  1018  	// Look up the wallet containing the requested signer
  1019  	account := accounts.Account{Address: addr}
  1020  
  1021  	wallet, err := s.b.AccountManager().Find(account)
  1022  	if err != nil {
  1023  		return nil, err
  1024  	}
  1025  	// Request the wallet to sign the transaction
  1026  	var chainID *big.Int
  1027  	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
  1028  		chainID = config.ChainId
  1029  	}
  1030  	return wallet.SignTx(account, tx, chainID)
  1031  }
  1032  
  1033  // SendTxArgs represents the arguments to sumbit a new transaction into the transaction pool.
  1034  type SendTxArgs struct {
  1035  	From     common.Address  `json:"from"`
  1036  	To       *common.Address `json:"to"`
  1037  	Gas      *hexutil.Big    `json:"gas"`
  1038  	GasPrice *hexutil.Big    `json:"gasPrice"`
  1039  	Value    *hexutil.Big    `json:"value"`
  1040  	Data     hexutil.Bytes   `json:"data"`
  1041  	Nonce    *hexutil.Uint64 `json:"nonce"`
  1042  }
  1043  
  1044  // prepareSendTxArgs is a helper function that fills in default values for unspecified tx fields.
  1045  func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
  1046  	if args.Gas == nil {
  1047  		args.Gas = (*hexutil.Big)(big.NewInt(defaultGas))
  1048  	}
  1049  	if args.GasPrice == nil {
  1050  		price, err := b.SuggestPrice(ctx)
  1051  		if err != nil {
  1052  			return err
  1053  		}
  1054  		args.GasPrice = (*hexutil.Big)(price)
  1055  	}
  1056  	if args.Value == nil {
  1057  		args.Value = new(hexutil.Big)
  1058  	}
  1059  	if args.Nonce == nil {
  1060  		nonce, err := b.GetPoolNonce(ctx, args.From)
  1061  		if err != nil {
  1062  			return err
  1063  		}
  1064  		args.Nonce = (*hexutil.Uint64)(&nonce)
  1065  	}
  1066  	return nil
  1067  }
  1068  
  1069  func (args *SendTxArgs) toTransaction() *types.Transaction {
  1070  	if args.To == nil {
  1071  		return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), (*big.Int)(args.Gas), (*big.Int)(args.GasPrice), args.Data)
  1072  	}
  1073  	return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), (*big.Int)(args.Gas), (*big.Int)(args.GasPrice), args.Data)
  1074  }
  1075  
  1076  // submitTransaction is a helper function that submits tx to txPool and logs a message.
  1077  func submitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) {
  1078  	if err := b.SendTx(ctx, tx); err != nil {
  1079  		return common.Hash{}, err
  1080  	}
  1081  	if tx.To() == nil {
  1082  		signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
  1083  		from, _ := types.Sender(signer, tx)
  1084  		addr := crypto.CreateAddress(from, tx.Nonce())
  1085  		log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
  1086  	} else {
  1087  		log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
  1088  	}
  1089  	return tx.Hash(), nil
  1090  }
  1091  
  1092  // SendTransaction creates a transaction for the given argument, sign it and submit it to the
  1093  // transaction pool.
  1094  func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args SendTxArgs) (common.Hash, error) {
  1095  
  1096  	// Look up the wallet containing the requested signer
  1097  	account := accounts.Account{Address: args.From}
  1098  
  1099  	wallet, err := s.b.AccountManager().Find(account)
  1100  	if err != nil {
  1101  		return common.Hash{}, err
  1102  	}
  1103  
  1104  	if args.Nonce == nil {
  1105  		// Hold the addresse's mutex around signing to prevent concurrent assignment of
  1106  		// the same nonce to multiple accounts.
  1107  		s.nonceLock.LockAddr(args.From)
  1108  		defer s.nonceLock.UnlockAddr(args.From)
  1109  	}
  1110  
  1111  	// Set some sanity defaults and terminate on failure
  1112  	if err := args.setDefaults(ctx, s.b); err != nil {
  1113  		return common.Hash{}, err
  1114  	}
  1115  	// Assemble the transaction and sign with the wallet
  1116  	tx := args.toTransaction()
  1117  
  1118  	var chainID *big.Int
  1119  	if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
  1120  		chainID = config.ChainId
  1121  	}
  1122  	signed, err := wallet.SignTx(account, tx, chainID)
  1123  	if err != nil {
  1124  		return common.Hash{}, err
  1125  	}
  1126  	return submitTransaction(ctx, s.b, signed)
  1127  }
  1128  
  1129  // SendRawTransaction will add the signed transaction to the transaction pool.
  1130  // The sender is responsible for signing the transaction and using the correct nonce.
  1131  func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (string, error) {
  1132  	tx := new(types.Transaction)
  1133  	if err := rlp.DecodeBytes(encodedTx, tx); err != nil {
  1134  		return "", err
  1135  	}
  1136  
  1137  	if err := s.b.SendTx(ctx, tx); err != nil {
  1138  		return "", err
  1139  	}
  1140  
  1141  	signer := types.MakeSigner(s.b.ChainConfig(), s.b.CurrentBlock().Number())
  1142  	if tx.To() == nil {
  1143  		from, err := types.Sender(signer, tx)
  1144  		if err != nil {
  1145  			return "", err
  1146  		}
  1147  		addr := crypto.CreateAddress(from, tx.Nonce())
  1148  		log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
  1149  	} else {
  1150  		log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
  1151  	}
  1152  
  1153  	return tx.Hash().Hex(), nil
  1154  }
  1155  
  1156  // Sign calculates an ECDSA signature for:
  1157  // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
  1158  //
  1159  // Note, the produced signature conforms to the secp256k1 curve R, S and V values,
  1160  // where the V value will be 27 or 28 for legacy reasons.
  1161  //
  1162  // The account associated with addr must be unlocked.
  1163  //
  1164  // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
  1165  func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
  1166  	// Look up the wallet containing the requested signer
  1167  	account := accounts.Account{Address: addr}
  1168  
  1169  	wallet, err := s.b.AccountManager().Find(account)
  1170  	if err != nil {
  1171  		return nil, err
  1172  	}
  1173  	// Sign the requested hash with the wallet
  1174  	signature, err := wallet.SignHash(account, signHash(data))
  1175  	if err == nil {
  1176  		signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
  1177  	}
  1178  	return signature, err
  1179  }
  1180  
  1181  // SignTransactionResult represents a RLP encoded signed transaction.
  1182  type SignTransactionResult struct {
  1183  	Raw hexutil.Bytes      `json:"raw"`
  1184  	Tx  *types.Transaction `json:"tx"`
  1185  }
  1186  
  1187  // SignTransaction will sign the given transaction with the from account.
  1188  // The node needs to have the private key of the account corresponding with
  1189  // the given from address and it needs to be unlocked.
  1190  func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
  1191  	if args.Nonce == nil {
  1192  		// Hold the addresse's mutex around signing to prevent concurrent assignment of
  1193  		// the same nonce to multiple accounts.
  1194  		s.nonceLock.LockAddr(args.From)
  1195  		defer s.nonceLock.UnlockAddr(args.From)
  1196  	}
  1197  	if err := args.setDefaults(ctx, s.b); err != nil {
  1198  		return nil, err
  1199  	}
  1200  	tx, err := s.sign(args.From, args.toTransaction())
  1201  	if err != nil {
  1202  		return nil, err
  1203  	}
  1204  	data, err := rlp.EncodeToBytes(tx)
  1205  	if err != nil {
  1206  		return nil, err
  1207  	}
  1208  	return &SignTransactionResult{data, tx}, nil
  1209  }
  1210  
  1211  // PendingTransactions returns the transactions that are in the transaction pool and have a from address that is one of
  1212  // the accounts this node manages.
  1213  func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
  1214  	pending, err := s.b.GetPoolTransactions()
  1215  	if err != nil {
  1216  		return nil, err
  1217  	}
  1218  
  1219  	transactions := make([]*RPCTransaction, 0, len(pending))
  1220  	for _, tx := range pending {
  1221  		var signer types.Signer = types.HomesteadSigner{}
  1222  		if tx.Protected() {
  1223  			signer = types.NewEIP155Signer(tx.ChainId())
  1224  		}
  1225  		from, _ := types.Sender(signer, tx)
  1226  		if _, err := s.b.AccountManager().Find(accounts.Account{Address: from}); err == nil {
  1227  			transactions = append(transactions, newRPCPendingTransaction(tx))
  1228  		}
  1229  	}
  1230  	return transactions, nil
  1231  }
  1232  
  1233  // Resend accepts an existing transaction and a new gas price and limit. It will remove
  1234  // the given transaction from the pool and reinsert it with the new gas price and limit.
  1235  func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice, gasLimit *hexutil.Big) (common.Hash, error) {
  1236  	if sendArgs.Nonce == nil {
  1237  		return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec")
  1238  	}
  1239  	if err := sendArgs.setDefaults(ctx, s.b); err != nil {
  1240  		return common.Hash{}, err
  1241  	}
  1242  	matchTx := sendArgs.toTransaction()
  1243  	pending, err := s.b.GetPoolTransactions()
  1244  	if err != nil {
  1245  		return common.Hash{}, err
  1246  	}
  1247  
  1248  	for _, p := range pending {
  1249  		var signer types.Signer = types.HomesteadSigner{}
  1250  		if p.Protected() {
  1251  			signer = types.NewEIP155Signer(p.ChainId())
  1252  		}
  1253  		wantSigHash := signer.Hash(matchTx)
  1254  
  1255  		if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash {
  1256  			// Match. Re-sign and send the transaction.
  1257  			if gasPrice != nil {
  1258  				sendArgs.GasPrice = gasPrice
  1259  			}
  1260  			if gasLimit != nil {
  1261  				sendArgs.Gas = gasLimit
  1262  			}
  1263  			signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())
  1264  			if err != nil {
  1265  				return common.Hash{}, err
  1266  			}
  1267  			s.b.RemoveTx(p.Hash())
  1268  			if err = s.b.SendTx(ctx, signedTx); err != nil {
  1269  				return common.Hash{}, err
  1270  			}
  1271  			return signedTx.Hash(), nil
  1272  		}
  1273  	}
  1274  
  1275  	return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash())
  1276  }
  1277  
  1278  // PublicDebugAPI is the collection of Etheruem APIs exposed over the public
  1279  // debugging endpoint.
  1280  type PublicDebugAPI struct {
  1281  	b Backend
  1282  }
  1283  
  1284  // NewPublicDebugAPI creates a new API definition for the public debug methods
  1285  // of the Ethereum service.
  1286  func NewPublicDebugAPI(b Backend) *PublicDebugAPI {
  1287  	return &PublicDebugAPI{b: b}
  1288  }
  1289  
  1290  // GetBlockRlp retrieves the RLP encoded for of a single block.
  1291  func (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) {
  1292  	block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1293  	if block == nil {
  1294  		return "", fmt.Errorf("block #%d not found", number)
  1295  	}
  1296  	encoded, err := rlp.EncodeToBytes(block)
  1297  	if err != nil {
  1298  		return "", err
  1299  	}
  1300  	return fmt.Sprintf("%x", encoded), nil
  1301  }
  1302  
  1303  // PrintBlock retrieves a block and returns its pretty printed form.
  1304  func (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) {
  1305  	block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1306  	if block == nil {
  1307  		return "", fmt.Errorf("block #%d not found", number)
  1308  	}
  1309  	return fmt.Sprintf("%s", block), nil
  1310  }
  1311  
  1312  // SeedHash retrieves the seed hash of a block.
  1313  func (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) {
  1314  	block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1315  	if block == nil {
  1316  		return "", fmt.Errorf("block #%d not found", number)
  1317  	}
  1318  	return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil
  1319  }
  1320  
  1321  // PrivateDebugAPI is the collection of Etheruem APIs exposed over the private
  1322  // debugging endpoint.
  1323  type PrivateDebugAPI struct {
  1324  	b Backend
  1325  }
  1326  
  1327  // NewPrivateDebugAPI creates a new API definition for the private debug methods
  1328  // of the Ethereum service.
  1329  func NewPrivateDebugAPI(b Backend) *PrivateDebugAPI {
  1330  	return &PrivateDebugAPI{b: b}
  1331  }
  1332  
  1333  // ChaindbProperty returns leveldb properties of the chain database.
  1334  func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) {
  1335  	ldb, ok := api.b.ChainDb().(interface {
  1336  		LDB() *leveldb.DB
  1337  	})
  1338  	if !ok {
  1339  		return "", fmt.Errorf("chaindbProperty does not work for memory databases")
  1340  	}
  1341  	if property == "" {
  1342  		property = "leveldb.stats"
  1343  	} else if !strings.HasPrefix(property, "leveldb.") {
  1344  		property = "leveldb." + property
  1345  	}
  1346  	return ldb.LDB().GetProperty(property)
  1347  }
  1348  
  1349  func (api *PrivateDebugAPI) ChaindbCompact() error {
  1350  	ldb, ok := api.b.ChainDb().(interface {
  1351  		LDB() *leveldb.DB
  1352  	})
  1353  	if !ok {
  1354  		return fmt.Errorf("chaindbCompact does not work for memory databases")
  1355  	}
  1356  	for b := byte(0); b < 255; b++ {
  1357  		log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
  1358  		err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}})
  1359  		if err != nil {
  1360  			log.Error("Database compaction failed", "err", err)
  1361  			return err
  1362  		}
  1363  	}
  1364  	return nil
  1365  }
  1366  
  1367  // SetHead rewinds the head of the blockchain to a previous block.
  1368  func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
  1369  	api.b.SetHead(uint64(number))
  1370  }
  1371  
  1372  // PublicNetAPI offers network related RPC methods
  1373  type PublicNetAPI struct {
  1374  	net            *p2p.Server
  1375  	networkVersion uint64
  1376  }
  1377  
  1378  // NewPublicNetAPI creates a new net API instance.
  1379  func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
  1380  	return &PublicNetAPI{net, networkVersion}
  1381  }
  1382  
  1383  // Listening returns an indication if the node is listening for network connections.
  1384  func (s *PublicNetAPI) Listening() bool {
  1385  	return true // always listening
  1386  }
  1387  
  1388  // PeerCount returns the number of connected peers
  1389  func (s *PublicNetAPI) PeerCount() hexutil.Uint {
  1390  	return hexutil.Uint(s.net.PeerCount())
  1391  }
  1392  
  1393  // Version returns the current ethereum protocol version.
  1394  func (s *PublicNetAPI) Version() string {
  1395  	return fmt.Sprintf("%d", s.networkVersion)
  1396  }