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