github.com/fxsjy/go-ethereum@v1.8.4-0.20180410143526-2e247705cd27/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 "bytes" 21 "context" 22 "errors" 23 "fmt" 24 "math/big" 25 "strings" 26 "time" 27 28 "github.com/davecgh/go-spew/spew" 29 "github.com/ethereum/go-ethereum/accounts" 30 "github.com/ethereum/go-ethereum/accounts/keystore" 31 "github.com/ethereum/go-ethereum/common" 32 "github.com/ethereum/go-ethereum/common/hexutil" 33 "github.com/ethereum/go-ethereum/common/math" 34 "github.com/ethereum/go-ethereum/consensus/ethash" 35 "github.com/ethereum/go-ethereum/core" 36 "github.com/ethereum/go-ethereum/core/types" 37 "github.com/ethereum/go-ethereum/core/vm" 38 "github.com/ethereum/go-ethereum/crypto" 39 "github.com/ethereum/go-ethereum/log" 40 "github.com/ethereum/go-ethereum/p2p" 41 "github.com/ethereum/go-ethereum/params" 42 "github.com/ethereum/go-ethereum/rlp" 43 "github.com/ethereum/go-ethereum/rpc" 44 "github.com/syndtr/goleveldb/leveldb" 45 "github.com/syndtr/goleveldb/leveldb/util" 46 ) 47 48 const ( 49 defaultGasPrice = 50 * params.Shannon 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 Ethereum 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 gas × %v wei", tx.To().Hex(), tx.Value(), tx.Gas(), tx.GasPrice()) 156 } 157 return fmt.Sprintf("contract creation: %v wei + %v gas × %v wei", 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 Failure string `json:"failure,omitempty"` 235 Accounts []accounts.Account `json:"accounts,omitempty"` 236 } 237 238 // ListWallets will return a list of wallets this node manages. 239 func (s *PrivateAccountAPI) ListWallets() []rawWallet { 240 wallets := make([]rawWallet, 0) // return [] instead of nil if empty 241 for _, wallet := range s.am.Wallets() { 242 status, failure := wallet.Status() 243 244 raw := rawWallet{ 245 URL: wallet.URL().String(), 246 Status: status, 247 Accounts: wallet.Accounts(), 248 } 249 if failure != nil { 250 raw.Failure = failure.Error() 251 } 252 wallets = append(wallets, raw) 253 } 254 return wallets 255 } 256 257 // OpenWallet initiates a hardware wallet opening procedure, establishing a USB 258 // connection and attempting to authenticate via the provided passphrase. Note, 259 // the method may return an extra challenge requiring a second open (e.g. the 260 // Trezor PIN matrix challenge). 261 func (s *PrivateAccountAPI) OpenWallet(url string, passphrase *string) error { 262 wallet, err := s.am.Wallet(url) 263 if err != nil { 264 return err 265 } 266 pass := "" 267 if passphrase != nil { 268 pass = *passphrase 269 } 270 return wallet.Open(pass) 271 } 272 273 // DeriveAccount requests a HD wallet to derive a new account, optionally pinning 274 // it for later reuse. 275 func (s *PrivateAccountAPI) DeriveAccount(url string, path string, pin *bool) (accounts.Account, error) { 276 wallet, err := s.am.Wallet(url) 277 if err != nil { 278 return accounts.Account{}, err 279 } 280 derivPath, err := accounts.ParseDerivationPath(path) 281 if err != nil { 282 return accounts.Account{}, err 283 } 284 if pin == nil { 285 pin = new(bool) 286 } 287 return wallet.Derive(derivPath, *pin) 288 } 289 290 // NewAccount will create a new account and returns the address for the new account. 291 func (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) { 292 acc, err := fetchKeystore(s.am).NewAccount(password) 293 if err == nil { 294 return acc.Address, nil 295 } 296 return common.Address{}, err 297 } 298 299 // fetchKeystore retrives the encrypted keystore from the account manager. 300 func fetchKeystore(am *accounts.Manager) *keystore.KeyStore { 301 return am.Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore) 302 } 303 304 // ImportRawKey stores the given hex encoded ECDSA key into the key directory, 305 // encrypting it with the passphrase. 306 func (s *PrivateAccountAPI) ImportRawKey(privkey string, password string) (common.Address, error) { 307 key, err := crypto.HexToECDSA(privkey) 308 if err != nil { 309 return common.Address{}, err 310 } 311 acc, err := fetchKeystore(s.am).ImportECDSA(key, password) 312 return acc.Address, err 313 } 314 315 // UnlockAccount will unlock the account associated with the given address with 316 // the given password for duration seconds. If duration is nil it will use a 317 // default of 300 seconds. It returns an indication if the account was unlocked. 318 func (s *PrivateAccountAPI) UnlockAccount(addr common.Address, password string, duration *uint64) (bool, error) { 319 const max = uint64(time.Duration(math.MaxInt64) / time.Second) 320 var d time.Duration 321 if duration == nil { 322 d = 300 * time.Second 323 } else if *duration > max { 324 return false, errors.New("unlock duration too large") 325 } else { 326 d = time.Duration(*duration) * time.Second 327 } 328 err := fetchKeystore(s.am).TimedUnlock(accounts.Account{Address: addr}, password, d) 329 return err == nil, err 330 } 331 332 // LockAccount will lock the account associated with the given address when it's unlocked. 333 func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool { 334 return fetchKeystore(s.am).Lock(addr) == nil 335 } 336 337 // signTransactions sets defaults and signs the given transaction 338 // NOTE: the caller needs to ensure that the nonceLock is held, if applicable, 339 // and release it after the transaction has been submitted to the tx pool 340 func (s *PrivateAccountAPI) signTransaction(ctx context.Context, args SendTxArgs, passwd string) (*types.Transaction, error) { 341 // Look up the wallet containing the requested signer 342 account := accounts.Account{Address: args.From} 343 wallet, err := s.am.Find(account) 344 if err != nil { 345 return nil, err 346 } 347 // Set some sanity defaults and terminate on failure 348 if err := args.setDefaults(ctx, s.b); err != nil { 349 return nil, err 350 } 351 // Assemble the transaction and sign with the wallet 352 tx := args.toTransaction() 353 354 var chainID *big.Int 355 if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) { 356 chainID = config.ChainId 357 } 358 return wallet.SignTxWithPassphrase(account, passwd, tx, chainID) 359 } 360 361 // SendTransaction will create a transaction from the given arguments and 362 // tries to sign it with the key associated with args.To. If the given passwd isn't 363 // able to decrypt the key it fails. 364 func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) { 365 if args.Nonce == nil { 366 // Hold the addresse's mutex around signing to prevent concurrent assignment of 367 // the same nonce to multiple accounts. 368 s.nonceLock.LockAddr(args.From) 369 defer s.nonceLock.UnlockAddr(args.From) 370 } 371 signed, err := s.signTransaction(ctx, args, passwd) 372 if err != nil { 373 return common.Hash{}, err 374 } 375 return submitTransaction(ctx, s.b, signed) 376 } 377 378 // SignTransaction will create a transaction from the given arguments and 379 // tries to sign it with the key associated with args.To. If the given passwd isn't 380 // able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast 381 // to other nodes 382 func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args SendTxArgs, passwd string) (*SignTransactionResult, error) { 383 // No need to obtain the noncelock mutex, since we won't be sending this 384 // tx into the transaction pool, but right back to the user 385 if args.Gas == nil { 386 return nil, fmt.Errorf("gas not specified") 387 } 388 if args.GasPrice == nil { 389 return nil, fmt.Errorf("gasPrice not specified") 390 } 391 if args.Nonce == nil { 392 return nil, fmt.Errorf("nonce not specified") 393 } 394 signed, err := s.signTransaction(ctx, args, passwd) 395 if err != nil { 396 return nil, err 397 } 398 data, err := rlp.EncodeToBytes(signed) 399 if err != nil { 400 return nil, err 401 } 402 return &SignTransactionResult{data, signed}, nil 403 } 404 405 // signHash is a helper function that calculates a hash for the given message that can be 406 // safely used to calculate a signature from. 407 // 408 // The hash is calulcated as 409 // keccak256("\x19Ethereum Signed Message:\n"${message length}${message}). 410 // 411 // This gives context to the signed message and prevents signing of transactions. 412 func signHash(data []byte) []byte { 413 msg := fmt.Sprintf("\x19Ethereum Signed Message:\n%d%s", len(data), data) 414 return crypto.Keccak256([]byte(msg)) 415 } 416 417 // Sign calculates an Ethereum ECDSA signature for: 418 // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message)) 419 // 420 // Note, the produced signature conforms to the secp256k1 curve R, S and V values, 421 // where the V value will be 27 or 28 for legacy reasons. 422 // 423 // The key used to calculate the signature is decrypted with the given password. 424 // 425 // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign 426 func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) { 427 // Look up the wallet containing the requested signer 428 account := accounts.Account{Address: addr} 429 430 wallet, err := s.b.AccountManager().Find(account) 431 if err != nil { 432 return nil, err 433 } 434 // Assemble sign the data with the wallet 435 signature, err := wallet.SignHashWithPassphrase(account, passwd, signHash(data)) 436 if err != nil { 437 return nil, err 438 } 439 signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper 440 return signature, nil 441 } 442 443 // EcRecover returns the address for the account that was used to create the signature. 444 // Note, this function is compatible with eth_sign and personal_sign. As such it recovers 445 // the address of: 446 // hash = keccak256("\x19Ethereum Signed Message:\n"${message length}${message}) 447 // addr = ecrecover(hash, signature) 448 // 449 // Note, the signature must conform to the secp256k1 curve R, S and V values, where 450 // the V value must be be 27 or 28 for legacy reasons. 451 // 452 // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover 453 func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) { 454 if len(sig) != 65 { 455 return common.Address{}, fmt.Errorf("signature must be 65 bytes long") 456 } 457 if sig[64] != 27 && sig[64] != 28 { 458 return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)") 459 } 460 sig[64] -= 27 // Transform yellow paper V from 27/28 to 0/1 461 462 rpk, err := crypto.Ecrecover(signHash(data), sig) 463 if err != nil { 464 return common.Address{}, err 465 } 466 pubKey := crypto.ToECDSAPub(rpk) 467 recoveredAddr := crypto.PubkeyToAddress(*pubKey) 468 return recoveredAddr, nil 469 } 470 471 // SignAndSendTransaction was renamed to SendTransaction. This method is deprecated 472 // and will be removed in the future. It primary goal is to give clients time to update. 473 func (s *PrivateAccountAPI) SignAndSendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) { 474 return s.SendTransaction(ctx, args, passwd) 475 } 476 477 // PublicBlockChainAPI provides an API to access the Ethereum blockchain. 478 // It offers only methods that operate on public data that is freely available to anyone. 479 type PublicBlockChainAPI struct { 480 b Backend 481 } 482 483 // NewPublicBlockChainAPI creates a new Ethereum blockchain API. 484 func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI { 485 return &PublicBlockChainAPI{b} 486 } 487 488 // BlockNumber returns the block number of the chain head. 489 func (s *PublicBlockChainAPI) BlockNumber() *big.Int { 490 header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available 491 return header.Number 492 } 493 494 // GetBalance returns the amount of wei for the given address in the state of the 495 // given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta 496 // block numbers are also allowed. 497 func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*big.Int, error) { 498 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 499 if state == nil || err != nil { 500 return nil, err 501 } 502 b := state.GetBalance(address) 503 return b, state.Error() 504 } 505 506 // GetBlockByNumber returns the requested block. When blockNr is -1 the chain head is returned. When fullTx is true all 507 // transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 508 func (s *PublicBlockChainAPI) GetBlockByNumber(ctx context.Context, blockNr rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) { 509 block, err := s.b.BlockByNumber(ctx, blockNr) 510 if block != nil { 511 response, err := s.rpcOutputBlock(block, true, fullTx) 512 if err == nil && blockNr == rpc.PendingBlockNumber { 513 // Pending blocks need to nil out a few fields 514 for _, field := range []string{"hash", "nonce", "miner"} { 515 response[field] = nil 516 } 517 } 518 return response, err 519 } 520 return nil, err 521 } 522 523 // GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full 524 // detail, otherwise only the transaction hash is returned. 525 func (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, blockHash common.Hash, fullTx bool) (map[string]interface{}, error) { 526 block, err := s.b.GetBlock(ctx, blockHash) 527 if block != nil { 528 return s.rpcOutputBlock(block, true, fullTx) 529 } 530 return nil, err 531 } 532 533 // GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true 534 // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 535 func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) { 536 block, err := s.b.BlockByNumber(ctx, blockNr) 537 if block != nil { 538 uncles := block.Uncles() 539 if index >= hexutil.Uint(len(uncles)) { 540 log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index) 541 return nil, nil 542 } 543 block = types.NewBlockWithHeader(uncles[index]) 544 return s.rpcOutputBlock(block, false, false) 545 } 546 return nil, err 547 } 548 549 // GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true 550 // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 551 func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) { 552 block, err := s.b.GetBlock(ctx, blockHash) 553 if block != nil { 554 uncles := block.Uncles() 555 if index >= hexutil.Uint(len(uncles)) { 556 log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index) 557 return nil, nil 558 } 559 block = types.NewBlockWithHeader(uncles[index]) 560 return s.rpcOutputBlock(block, false, false) 561 } 562 return nil, err 563 } 564 565 // GetUncleCountByBlockNumber returns number of uncles in the block for the given block number 566 func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint { 567 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 568 n := hexutil.Uint(len(block.Uncles())) 569 return &n 570 } 571 return nil 572 } 573 574 // GetUncleCountByBlockHash returns number of uncles in the block for the given block hash 575 func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint { 576 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 577 n := hexutil.Uint(len(block.Uncles())) 578 return &n 579 } 580 return nil 581 } 582 583 // GetCode returns the code stored at the given address in the state for the given block number. 584 func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (hexutil.Bytes, error) { 585 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 586 if state == nil || err != nil { 587 return nil, err 588 } 589 code := state.GetCode(address) 590 return code, state.Error() 591 } 592 593 // GetStorageAt returns the storage from the state at the given address, key and 594 // block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block 595 // numbers are also allowed. 596 func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNr rpc.BlockNumber) (hexutil.Bytes, error) { 597 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 598 if state == nil || err != nil { 599 return nil, err 600 } 601 res := state.GetState(address, common.HexToHash(key)) 602 return res[:], state.Error() 603 } 604 605 // CallArgs represents the arguments for a call. 606 type CallArgs struct { 607 From common.Address `json:"from"` 608 To *common.Address `json:"to"` 609 Gas hexutil.Uint64 `json:"gas"` 610 GasPrice hexutil.Big `json:"gasPrice"` 611 Value hexutil.Big `json:"value"` 612 Data hexutil.Bytes `json:"data"` 613 } 614 615 func (s *PublicBlockChainAPI) doCall(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber, vmCfg vm.Config, timeout time.Duration) ([]byte, uint64, bool, error) { 616 defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now()) 617 618 state, header, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 619 if state == nil || err != nil { 620 return nil, 0, false, err 621 } 622 // Set sender address or use a default if none specified 623 addr := args.From 624 if addr == (common.Address{}) { 625 if wallets := s.b.AccountManager().Wallets(); len(wallets) > 0 { 626 if accounts := wallets[0].Accounts(); len(accounts) > 0 { 627 addr = accounts[0].Address 628 } 629 } 630 } 631 // Set default gas & gas price if none were set 632 gas, gasPrice := uint64(args.Gas), args.GasPrice.ToInt() 633 if gas == 0 { 634 gas = math.MaxUint64 / 2 635 } 636 if gasPrice.Sign() == 0 { 637 gasPrice = new(big.Int).SetUint64(defaultGasPrice) 638 } 639 640 // Create new call message 641 msg := types.NewMessage(addr, args.To, 0, args.Value.ToInt(), gas, gasPrice, args.Data, false) 642 643 // Setup context so it may be cancelled the call has completed 644 // or, in case of unmetered gas, setup a context with a timeout. 645 var cancel context.CancelFunc 646 if timeout > 0 { 647 ctx, cancel = context.WithTimeout(ctx, timeout) 648 } else { 649 ctx, cancel = context.WithCancel(ctx) 650 } 651 // Make sure the context is cancelled when the call has completed 652 // this makes sure resources are cleaned up. 653 defer cancel() 654 655 // Get a new instance of the EVM. 656 evm, vmError, err := s.b.GetEVM(ctx, msg, state, header, vmCfg) 657 if err != nil { 658 return nil, 0, false, err 659 } 660 // Wait for the context to be done and cancel the evm. Even if the 661 // EVM has finished, cancelling may be done (repeatedly) 662 go func() { 663 <-ctx.Done() 664 evm.Cancel() 665 }() 666 667 // Setup the gas pool (also for unmetered requests) 668 // and apply the message. 669 gp := new(core.GasPool).AddGas(math.MaxUint64) 670 res, gas, failed, err := core.ApplyMessage(evm, msg, gp) 671 if err := vmError(); err != nil { 672 return nil, 0, false, err 673 } 674 return res, gas, failed, err 675 } 676 677 // Call executes the given transaction on the state for the given block number. 678 // It doesn't make and changes in the state/blockchain and is useful to execute and retrieve values. 679 func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Bytes, error) { 680 result, _, _, err := s.doCall(ctx, args, blockNr, vm.Config{}, 5*time.Second) 681 return (hexutil.Bytes)(result), err 682 } 683 684 // EstimateGas returns an estimate of the amount of gas needed to execute the 685 // given transaction against the current pending block. 686 func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (hexutil.Uint64, error) { 687 // Binary search the gas requirement, as it may be higher than the amount used 688 var ( 689 lo uint64 = params.TxGas - 1 690 hi uint64 691 cap uint64 692 ) 693 if uint64(args.Gas) >= params.TxGas { 694 hi = uint64(args.Gas) 695 } else { 696 // Retrieve the current pending block to act as the gas ceiling 697 block, err := s.b.BlockByNumber(ctx, rpc.PendingBlockNumber) 698 if err != nil { 699 return 0, err 700 } 701 hi = block.GasLimit() 702 } 703 cap = hi 704 705 // Create a helper to check if a gas allowance results in an executable transaction 706 executable := func(gas uint64) bool { 707 args.Gas = hexutil.Uint64(gas) 708 709 _, _, failed, err := s.doCall(ctx, args, rpc.PendingBlockNumber, vm.Config{}, 0) 710 if err != nil || failed { 711 return false 712 } 713 return true 714 } 715 // Execute the binary search and hone in on an executable gas limit 716 for lo+1 < hi { 717 mid := (hi + lo) / 2 718 if !executable(mid) { 719 lo = mid 720 } else { 721 hi = mid 722 } 723 } 724 // Reject the transaction as invalid if it still fails at the highest allowance 725 if hi == cap { 726 if !executable(hi) { 727 return 0, fmt.Errorf("gas required exceeds allowance or always failing transaction") 728 } 729 } 730 return hexutil.Uint64(hi), nil 731 } 732 733 // ExecutionResult groups all structured logs emitted by the EVM 734 // while replaying a transaction in debug mode as well as transaction 735 // execution status, the amount of gas used and the return value 736 type ExecutionResult struct { 737 Gas uint64 `json:"gas"` 738 Failed bool `json:"failed"` 739 ReturnValue string `json:"returnValue"` 740 StructLogs []StructLogRes `json:"structLogs"` 741 } 742 743 // StructLogRes stores a structured log emitted by the EVM while replaying a 744 // transaction in debug mode 745 type StructLogRes struct { 746 Pc uint64 `json:"pc"` 747 Op string `json:"op"` 748 Gas uint64 `json:"gas"` 749 GasCost uint64 `json:"gasCost"` 750 Depth int `json:"depth"` 751 Error error `json:"error,omitempty"` 752 Stack *[]string `json:"stack,omitempty"` 753 Memory *[]string `json:"memory,omitempty"` 754 Storage *map[string]string `json:"storage,omitempty"` 755 } 756 757 // formatLogs formats EVM returned structured logs for json output 758 func FormatLogs(logs []vm.StructLog) []StructLogRes { 759 formatted := make([]StructLogRes, len(logs)) 760 for index, trace := range logs { 761 formatted[index] = StructLogRes{ 762 Pc: trace.Pc, 763 Op: trace.Op.String(), 764 Gas: trace.Gas, 765 GasCost: trace.GasCost, 766 Depth: trace.Depth, 767 Error: trace.Err, 768 } 769 if trace.Stack != nil { 770 stack := make([]string, len(trace.Stack)) 771 for i, stackValue := range trace.Stack { 772 stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32)) 773 } 774 formatted[index].Stack = &stack 775 } 776 if trace.Memory != nil { 777 memory := make([]string, 0, (len(trace.Memory)+31)/32) 778 for i := 0; i+32 <= len(trace.Memory); i += 32 { 779 memory = append(memory, fmt.Sprintf("%x", trace.Memory[i:i+32])) 780 } 781 formatted[index].Memory = &memory 782 } 783 if trace.Storage != nil { 784 storage := make(map[string]string) 785 for i, storageValue := range trace.Storage { 786 storage[fmt.Sprintf("%x", i)] = fmt.Sprintf("%x", storageValue) 787 } 788 formatted[index].Storage = &storage 789 } 790 } 791 return formatted 792 } 793 794 // rpcOutputBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are 795 // returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain 796 // transaction hashes. 797 func (s *PublicBlockChainAPI) rpcOutputBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) { 798 head := b.Header() // copies the header once 799 fields := map[string]interface{}{ 800 "number": (*hexutil.Big)(head.Number), 801 "hash": b.Hash(), 802 "parentHash": head.ParentHash, 803 "nonce": head.Nonce, 804 "mixHash": head.MixDigest, 805 "sha3Uncles": head.UncleHash, 806 "logsBloom": head.Bloom, 807 "stateRoot": head.Root, 808 "miner": head.Coinbase, 809 "difficulty": (*hexutil.Big)(head.Difficulty), 810 "totalDifficulty": (*hexutil.Big)(s.b.GetTd(b.Hash())), 811 "extraData": hexutil.Bytes(head.Extra), 812 "size": hexutil.Uint64(b.Size()), 813 "gasLimit": hexutil.Uint64(head.GasLimit), 814 "gasUsed": hexutil.Uint64(head.GasUsed), 815 "timestamp": (*hexutil.Big)(head.Time), 816 "transactionsRoot": head.TxHash, 817 "receiptsRoot": head.ReceiptHash, 818 } 819 820 if inclTx { 821 formatTx := func(tx *types.Transaction) (interface{}, error) { 822 return tx.Hash(), nil 823 } 824 825 if fullTx { 826 formatTx = func(tx *types.Transaction) (interface{}, error) { 827 return newRPCTransactionFromBlockHash(b, tx.Hash()), nil 828 } 829 } 830 831 txs := b.Transactions() 832 transactions := make([]interface{}, len(txs)) 833 var err error 834 for i, tx := range b.Transactions() { 835 if transactions[i], err = formatTx(tx); err != nil { 836 return nil, err 837 } 838 } 839 fields["transactions"] = transactions 840 } 841 842 uncles := b.Uncles() 843 uncleHashes := make([]common.Hash, len(uncles)) 844 for i, uncle := range uncles { 845 uncleHashes[i] = uncle.Hash() 846 } 847 fields["uncles"] = uncleHashes 848 849 return fields, nil 850 } 851 852 // RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction 853 type RPCTransaction struct { 854 BlockHash common.Hash `json:"blockHash"` 855 BlockNumber *hexutil.Big `json:"blockNumber"` 856 From common.Address `json:"from"` 857 Gas hexutil.Uint64 `json:"gas"` 858 GasPrice *hexutil.Big `json:"gasPrice"` 859 Hash common.Hash `json:"hash"` 860 Input hexutil.Bytes `json:"input"` 861 Nonce hexutil.Uint64 `json:"nonce"` 862 To *common.Address `json:"to"` 863 TransactionIndex hexutil.Uint `json:"transactionIndex"` 864 Value *hexutil.Big `json:"value"` 865 V *hexutil.Big `json:"v"` 866 R *hexutil.Big `json:"r"` 867 S *hexutil.Big `json:"s"` 868 } 869 870 // newRPCTransaction returns a transaction that will serialize to the RPC 871 // representation, with the given location metadata set (if available). 872 func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64) *RPCTransaction { 873 var signer types.Signer = types.FrontierSigner{} 874 if tx.Protected() { 875 signer = types.NewEIP155Signer(tx.ChainId()) 876 } 877 from, _ := types.Sender(signer, tx) 878 v, r, s := tx.RawSignatureValues() 879 880 result := &RPCTransaction{ 881 From: from, 882 Gas: hexutil.Uint64(tx.Gas()), 883 GasPrice: (*hexutil.Big)(tx.GasPrice()), 884 Hash: tx.Hash(), 885 Input: hexutil.Bytes(tx.Data()), 886 Nonce: hexutil.Uint64(tx.Nonce()), 887 To: tx.To(), 888 Value: (*hexutil.Big)(tx.Value()), 889 V: (*hexutil.Big)(v), 890 R: (*hexutil.Big)(r), 891 S: (*hexutil.Big)(s), 892 } 893 if blockHash != (common.Hash{}) { 894 result.BlockHash = blockHash 895 result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber)) 896 result.TransactionIndex = hexutil.Uint(index) 897 } 898 return result 899 } 900 901 // newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation 902 func newRPCPendingTransaction(tx *types.Transaction) *RPCTransaction { 903 return newRPCTransaction(tx, common.Hash{}, 0, 0) 904 } 905 906 // newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation. 907 func newRPCTransactionFromBlockIndex(b *types.Block, index uint64) *RPCTransaction { 908 txs := b.Transactions() 909 if index >= uint64(len(txs)) { 910 return nil 911 } 912 return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index) 913 } 914 915 // newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index. 916 func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes { 917 txs := b.Transactions() 918 if index >= uint64(len(txs)) { 919 return nil 920 } 921 blob, _ := rlp.EncodeToBytes(txs[index]) 922 return blob 923 } 924 925 // newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation. 926 func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction { 927 for idx, tx := range b.Transactions() { 928 if tx.Hash() == hash { 929 return newRPCTransactionFromBlockIndex(b, uint64(idx)) 930 } 931 } 932 return nil 933 } 934 935 // PublicTransactionPoolAPI exposes methods for the RPC interface 936 type PublicTransactionPoolAPI struct { 937 b Backend 938 nonceLock *AddrLocker 939 } 940 941 // NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool. 942 func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI { 943 return &PublicTransactionPoolAPI{b, nonceLock} 944 } 945 946 // GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number. 947 func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint { 948 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 949 n := hexutil.Uint(len(block.Transactions())) 950 return &n 951 } 952 return nil 953 } 954 955 // GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash. 956 func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint { 957 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 958 n := hexutil.Uint(len(block.Transactions())) 959 return &n 960 } 961 return nil 962 } 963 964 // GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index. 965 func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction { 966 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 967 return newRPCTransactionFromBlockIndex(block, uint64(index)) 968 } 969 return nil 970 } 971 972 // GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index. 973 func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction { 974 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 975 return newRPCTransactionFromBlockIndex(block, uint64(index)) 976 } 977 return nil 978 } 979 980 // GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index. 981 func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes { 982 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 983 return newRPCRawTransactionFromBlockIndex(block, uint64(index)) 984 } 985 return nil 986 } 987 988 // GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index. 989 func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes { 990 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 991 return newRPCRawTransactionFromBlockIndex(block, uint64(index)) 992 } 993 return nil 994 } 995 996 // GetTransactionCount returns the number of transactions the given address has sent for the given block number 997 func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) { 998 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 999 if state == nil || err != nil { 1000 return nil, err 1001 } 1002 nonce := state.GetNonce(address) 1003 return (*hexutil.Uint64)(&nonce), state.Error() 1004 } 1005 1006 // GetTransactionByHash returns the transaction for the given hash 1007 func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) *RPCTransaction { 1008 // Try to return an already finalized transaction 1009 if tx, blockHash, blockNumber, index := core.GetTransaction(s.b.ChainDb(), hash); tx != nil { 1010 return newRPCTransaction(tx, blockHash, blockNumber, index) 1011 } 1012 // No finalized transaction, try to retrieve it from the pool 1013 if tx := s.b.GetPoolTransaction(hash); tx != nil { 1014 return newRPCPendingTransaction(tx) 1015 } 1016 // Transaction unknown, return as such 1017 return nil 1018 } 1019 1020 // GetRawTransactionByHash returns the bytes of the transaction for the given hash. 1021 func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) { 1022 var tx *types.Transaction 1023 1024 // Retrieve a finalized transaction, or a pooled otherwise 1025 if tx, _, _, _ = core.GetTransaction(s.b.ChainDb(), hash); tx == nil { 1026 if tx = s.b.GetPoolTransaction(hash); tx == nil { 1027 // Transaction not found anywhere, abort 1028 return nil, nil 1029 } 1030 } 1031 // Serialize to RLP and return 1032 return rlp.EncodeToBytes(tx) 1033 } 1034 1035 // GetTransactionReceipt returns the transaction receipt for the given transaction hash. 1036 func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) { 1037 tx, blockHash, blockNumber, index := core.GetTransaction(s.b.ChainDb(), hash) 1038 if tx == nil { 1039 return nil, nil 1040 } 1041 receipts, err := s.b.GetReceipts(ctx, blockHash) 1042 if err != nil { 1043 return nil, err 1044 } 1045 if len(receipts) <= int(index) { 1046 return nil, nil 1047 } 1048 receipt := receipts[index] 1049 1050 var signer types.Signer = types.FrontierSigner{} 1051 if tx.Protected() { 1052 signer = types.NewEIP155Signer(tx.ChainId()) 1053 } 1054 from, _ := types.Sender(signer, tx) 1055 1056 fields := map[string]interface{}{ 1057 "blockHash": blockHash, 1058 "blockNumber": hexutil.Uint64(blockNumber), 1059 "transactionHash": hash, 1060 "transactionIndex": hexutil.Uint64(index), 1061 "from": from, 1062 "to": tx.To(), 1063 "gasUsed": hexutil.Uint64(receipt.GasUsed), 1064 "cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed), 1065 "contractAddress": nil, 1066 "logs": receipt.Logs, 1067 "logsBloom": receipt.Bloom, 1068 } 1069 1070 // Assign receipt status or post state. 1071 if len(receipt.PostState) > 0 { 1072 fields["root"] = hexutil.Bytes(receipt.PostState) 1073 } else { 1074 fields["status"] = hexutil.Uint(receipt.Status) 1075 } 1076 if receipt.Logs == nil { 1077 fields["logs"] = [][]*types.Log{} 1078 } 1079 // If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation 1080 if receipt.ContractAddress != (common.Address{}) { 1081 fields["contractAddress"] = receipt.ContractAddress 1082 } 1083 return fields, nil 1084 } 1085 1086 // sign is a helper function that signs a transaction with the private key of the given address. 1087 func (s *PublicTransactionPoolAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) { 1088 // Look up the wallet containing the requested signer 1089 account := accounts.Account{Address: addr} 1090 1091 wallet, err := s.b.AccountManager().Find(account) 1092 if err != nil { 1093 return nil, err 1094 } 1095 // Request the wallet to sign the transaction 1096 var chainID *big.Int 1097 if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) { 1098 chainID = config.ChainId 1099 } 1100 return wallet.SignTx(account, tx, chainID) 1101 } 1102 1103 // SendTxArgs represents the arguments to sumbit a new transaction into the transaction pool. 1104 type SendTxArgs struct { 1105 From common.Address `json:"from"` 1106 To *common.Address `json:"to"` 1107 Gas *hexutil.Uint64 `json:"gas"` 1108 GasPrice *hexutil.Big `json:"gasPrice"` 1109 Value *hexutil.Big `json:"value"` 1110 Nonce *hexutil.Uint64 `json:"nonce"` 1111 // We accept "data" and "input" for backwards-compatibility reasons. "input" is the 1112 // newer name and should be preferred by clients. 1113 Data *hexutil.Bytes `json:"data"` 1114 Input *hexutil.Bytes `json:"input"` 1115 } 1116 1117 // setDefaults is a helper function that fills in default values for unspecified tx fields. 1118 func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error { 1119 if args.Gas == nil { 1120 args.Gas = new(hexutil.Uint64) 1121 *(*uint64)(args.Gas) = 90000 1122 } 1123 if args.GasPrice == nil { 1124 price, err := b.SuggestPrice(ctx) 1125 if err != nil { 1126 return err 1127 } 1128 args.GasPrice = (*hexutil.Big)(price) 1129 } 1130 if args.Value == nil { 1131 args.Value = new(hexutil.Big) 1132 } 1133 if args.Nonce == nil { 1134 nonce, err := b.GetPoolNonce(ctx, args.From) 1135 if err != nil { 1136 return err 1137 } 1138 args.Nonce = (*hexutil.Uint64)(&nonce) 1139 } 1140 if args.Data != nil && args.Input != nil && !bytes.Equal(*args.Data, *args.Input) { 1141 return errors.New(`Both "data" and "input" are set and not equal. Please use "input" to pass transaction call data.`) 1142 } 1143 if args.To == nil { 1144 // Contract creation 1145 var input []byte 1146 if args.Data != nil { 1147 input = *args.Data 1148 } else if args.Input != nil { 1149 input = *args.Input 1150 } 1151 if len(input) == 0 { 1152 return errors.New(`contract creation without any data provided`) 1153 } 1154 } 1155 return nil 1156 } 1157 1158 func (args *SendTxArgs) toTransaction() *types.Transaction { 1159 var input []byte 1160 if args.Data != nil { 1161 input = *args.Data 1162 } else if args.Input != nil { 1163 input = *args.Input 1164 } 1165 if args.To == nil { 1166 return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input) 1167 } 1168 return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input) 1169 } 1170 1171 // submitTransaction is a helper function that submits tx to txPool and logs a message. 1172 func submitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) { 1173 if err := b.SendTx(ctx, tx); err != nil { 1174 return common.Hash{}, err 1175 } 1176 if tx.To() == nil { 1177 signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number()) 1178 from, err := types.Sender(signer, tx) 1179 if err != nil { 1180 return common.Hash{}, err 1181 } 1182 addr := crypto.CreateAddress(from, tx.Nonce()) 1183 log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex()) 1184 } else { 1185 log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To()) 1186 } 1187 return tx.Hash(), nil 1188 } 1189 1190 // SendTransaction creates a transaction for the given argument, sign it and submit it to the 1191 // transaction pool. 1192 func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args SendTxArgs) (common.Hash, error) { 1193 1194 // Look up the wallet containing the requested signer 1195 account := accounts.Account{Address: args.From} 1196 1197 wallet, err := s.b.AccountManager().Find(account) 1198 if err != nil { 1199 return common.Hash{}, err 1200 } 1201 1202 if args.Nonce == nil { 1203 // Hold the addresse's mutex around signing to prevent concurrent assignment of 1204 // the same nonce to multiple accounts. 1205 s.nonceLock.LockAddr(args.From) 1206 defer s.nonceLock.UnlockAddr(args.From) 1207 } 1208 1209 // Set some sanity defaults and terminate on failure 1210 if err := args.setDefaults(ctx, s.b); err != nil { 1211 return common.Hash{}, err 1212 } 1213 // Assemble the transaction and sign with the wallet 1214 tx := args.toTransaction() 1215 1216 var chainID *big.Int 1217 if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) { 1218 chainID = config.ChainId 1219 } 1220 signed, err := wallet.SignTx(account, tx, chainID) 1221 if err != nil { 1222 return common.Hash{}, err 1223 } 1224 return submitTransaction(ctx, s.b, signed) 1225 } 1226 1227 // SendRawTransaction will add the signed transaction to the transaction pool. 1228 // The sender is responsible for signing the transaction and using the correct nonce. 1229 func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) { 1230 tx := new(types.Transaction) 1231 if err := rlp.DecodeBytes(encodedTx, tx); err != nil { 1232 return common.Hash{}, err 1233 } 1234 return submitTransaction(ctx, s.b, tx) 1235 } 1236 1237 // Sign calculates an ECDSA signature for: 1238 // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message). 1239 // 1240 // Note, the produced signature conforms to the secp256k1 curve R, S and V values, 1241 // where the V value will be 27 or 28 for legacy reasons. 1242 // 1243 // The account associated with addr must be unlocked. 1244 // 1245 // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign 1246 func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) { 1247 // Look up the wallet containing the requested signer 1248 account := accounts.Account{Address: addr} 1249 1250 wallet, err := s.b.AccountManager().Find(account) 1251 if err != nil { 1252 return nil, err 1253 } 1254 // Sign the requested hash with the wallet 1255 signature, err := wallet.SignHash(account, signHash(data)) 1256 if err == nil { 1257 signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper 1258 } 1259 return signature, err 1260 } 1261 1262 // SignTransactionResult represents a RLP encoded signed transaction. 1263 type SignTransactionResult struct { 1264 Raw hexutil.Bytes `json:"raw"` 1265 Tx *types.Transaction `json:"tx"` 1266 } 1267 1268 // SignTransaction will sign the given transaction with the from account. 1269 // The node needs to have the private key of the account corresponding with 1270 // the given from address and it needs to be unlocked. 1271 func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) { 1272 if args.Gas == nil { 1273 return nil, fmt.Errorf("gas not specified") 1274 } 1275 if args.GasPrice == nil { 1276 return nil, fmt.Errorf("gasPrice not specified") 1277 } 1278 if args.Nonce == nil { 1279 return nil, fmt.Errorf("nonce not specified") 1280 } 1281 if err := args.setDefaults(ctx, s.b); err != nil { 1282 return nil, err 1283 } 1284 tx, err := s.sign(args.From, args.toTransaction()) 1285 if err != nil { 1286 return nil, err 1287 } 1288 data, err := rlp.EncodeToBytes(tx) 1289 if err != nil { 1290 return nil, err 1291 } 1292 return &SignTransactionResult{data, tx}, nil 1293 } 1294 1295 // PendingTransactions returns the transactions that are in the transaction pool and have a from address that is one of 1296 // the accounts this node manages. 1297 func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) { 1298 pending, err := s.b.GetPoolTransactions() 1299 if err != nil { 1300 return nil, err 1301 } 1302 1303 transactions := make([]*RPCTransaction, 0, len(pending)) 1304 for _, tx := range pending { 1305 var signer types.Signer = types.HomesteadSigner{} 1306 if tx.Protected() { 1307 signer = types.NewEIP155Signer(tx.ChainId()) 1308 } 1309 from, _ := types.Sender(signer, tx) 1310 if _, err := s.b.AccountManager().Find(accounts.Account{Address: from}); err == nil { 1311 transactions = append(transactions, newRPCPendingTransaction(tx)) 1312 } 1313 } 1314 return transactions, nil 1315 } 1316 1317 // Resend accepts an existing transaction and a new gas price and limit. It will remove 1318 // the given transaction from the pool and reinsert it with the new gas price and limit. 1319 func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) { 1320 if sendArgs.Nonce == nil { 1321 return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec") 1322 } 1323 if err := sendArgs.setDefaults(ctx, s.b); err != nil { 1324 return common.Hash{}, err 1325 } 1326 matchTx := sendArgs.toTransaction() 1327 pending, err := s.b.GetPoolTransactions() 1328 if err != nil { 1329 return common.Hash{}, err 1330 } 1331 1332 for _, p := range pending { 1333 var signer types.Signer = types.HomesteadSigner{} 1334 if p.Protected() { 1335 signer = types.NewEIP155Signer(p.ChainId()) 1336 } 1337 wantSigHash := signer.Hash(matchTx) 1338 1339 if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash { 1340 // Match. Re-sign and send the transaction. 1341 if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 { 1342 sendArgs.GasPrice = gasPrice 1343 } 1344 if gasLimit != nil && *gasLimit != 0 { 1345 sendArgs.Gas = gasLimit 1346 } 1347 signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction()) 1348 if err != nil { 1349 return common.Hash{}, err 1350 } 1351 if err = s.b.SendTx(ctx, signedTx); err != nil { 1352 return common.Hash{}, err 1353 } 1354 return signedTx.Hash(), nil 1355 } 1356 } 1357 1358 return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash()) 1359 } 1360 1361 // PublicDebugAPI is the collection of Ethereum APIs exposed over the public 1362 // debugging endpoint. 1363 type PublicDebugAPI struct { 1364 b Backend 1365 } 1366 1367 // NewPublicDebugAPI creates a new API definition for the public debug methods 1368 // of the Ethereum service. 1369 func NewPublicDebugAPI(b Backend) *PublicDebugAPI { 1370 return &PublicDebugAPI{b: b} 1371 } 1372 1373 // GetBlockRlp retrieves the RLP encoded for of a single block. 1374 func (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) { 1375 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1376 if block == nil { 1377 return "", fmt.Errorf("block #%d not found", number) 1378 } 1379 encoded, err := rlp.EncodeToBytes(block) 1380 if err != nil { 1381 return "", err 1382 } 1383 return fmt.Sprintf("%x", encoded), nil 1384 } 1385 1386 // PrintBlock retrieves a block and returns its pretty printed form. 1387 func (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) { 1388 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1389 if block == nil { 1390 return "", fmt.Errorf("block #%d not found", number) 1391 } 1392 return spew.Sdump(block), nil 1393 } 1394 1395 // SeedHash retrieves the seed hash of a block. 1396 func (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) { 1397 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1398 if block == nil { 1399 return "", fmt.Errorf("block #%d not found", number) 1400 } 1401 return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil 1402 } 1403 1404 // PrivateDebugAPI is the collection of Ethereum APIs exposed over the private 1405 // debugging endpoint. 1406 type PrivateDebugAPI struct { 1407 b Backend 1408 } 1409 1410 // NewPrivateDebugAPI creates a new API definition for the private debug methods 1411 // of the Ethereum service. 1412 func NewPrivateDebugAPI(b Backend) *PrivateDebugAPI { 1413 return &PrivateDebugAPI{b: b} 1414 } 1415 1416 // ChaindbProperty returns leveldb properties of the chain database. 1417 func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) { 1418 ldb, ok := api.b.ChainDb().(interface { 1419 LDB() *leveldb.DB 1420 }) 1421 if !ok { 1422 return "", fmt.Errorf("chaindbProperty does not work for memory databases") 1423 } 1424 if property == "" { 1425 property = "leveldb.stats" 1426 } else if !strings.HasPrefix(property, "leveldb.") { 1427 property = "leveldb." + property 1428 } 1429 return ldb.LDB().GetProperty(property) 1430 } 1431 1432 func (api *PrivateDebugAPI) ChaindbCompact() error { 1433 ldb, ok := api.b.ChainDb().(interface { 1434 LDB() *leveldb.DB 1435 }) 1436 if !ok { 1437 return fmt.Errorf("chaindbCompact does not work for memory databases") 1438 } 1439 for b := byte(0); b < 255; b++ { 1440 log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1)) 1441 err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}}) 1442 if err != nil { 1443 log.Error("Database compaction failed", "err", err) 1444 return err 1445 } 1446 } 1447 return nil 1448 } 1449 1450 // SetHead rewinds the head of the blockchain to a previous block. 1451 func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) { 1452 api.b.SetHead(uint64(number)) 1453 } 1454 1455 // PublicNetAPI offers network related RPC methods 1456 type PublicNetAPI struct { 1457 net *p2p.Server 1458 networkVersion uint64 1459 } 1460 1461 // NewPublicNetAPI creates a new net API instance. 1462 func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI { 1463 return &PublicNetAPI{net, networkVersion} 1464 } 1465 1466 // Listening returns an indication if the node is listening for network connections. 1467 func (s *PublicNetAPI) Listening() bool { 1468 return true // always listening 1469 } 1470 1471 // PeerCount returns the number of connected peers 1472 func (s *PublicNetAPI) PeerCount() hexutil.Uint { 1473 return hexutil.Uint(s.net.PeerCount()) 1474 } 1475 1476 // Version returns the current ethereum protocol version. 1477 func (s *PublicNetAPI) Version() string { 1478 return fmt.Sprintf("%d", s.networkVersion) 1479 }