github.com/shirikatsu/go-ethereum@v1.8.19/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 (s *PublicBlockChainAPI) doCall(ctx context.Context, 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 := s.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 addr := args.From 695 if addr == (common.Address{}) { 696 if wallets := s.b.AccountManager().Wallets(); len(wallets) > 0 { 697 if accounts := wallets[0].Accounts(); len(accounts) > 0 { 698 addr = accounts[0].Address 699 } 700 } 701 } 702 // Set default gas & gas price if none were set 703 gas, gasPrice := uint64(args.Gas), args.GasPrice.ToInt() 704 if gas == 0 { 705 gas = math.MaxUint64 / 2 706 } 707 if gasPrice.Sign() == 0 { 708 gasPrice = new(big.Int).SetUint64(defaultGasPrice) 709 } 710 711 // Create new call message 712 msg := types.NewMessage(addr, args.To, 0, args.Value.ToInt(), gas, gasPrice, args.Data, false) 713 714 // Setup context so it may be cancelled the call has completed 715 // or, in case of unmetered gas, setup a context with a timeout. 716 var cancel context.CancelFunc 717 if timeout > 0 { 718 ctx, cancel = context.WithTimeout(ctx, timeout) 719 } else { 720 ctx, cancel = context.WithCancel(ctx) 721 } 722 // Make sure the context is cancelled when the call has completed 723 // this makes sure resources are cleaned up. 724 defer cancel() 725 726 // Get a new instance of the EVM. 727 evm, vmError, err := s.b.GetEVM(ctx, msg, state, header, vmCfg) 728 if err != nil { 729 return nil, 0, false, err 730 } 731 // Wait for the context to be done and cancel the evm. Even if the 732 // EVM has finished, cancelling may be done (repeatedly) 733 go func() { 734 <-ctx.Done() 735 evm.Cancel() 736 }() 737 738 // Setup the gas pool (also for unmetered requests) 739 // and apply the message. 740 gp := new(core.GasPool).AddGas(math.MaxUint64) 741 res, gas, failed, err := core.ApplyMessage(evm, msg, gp) 742 if err := vmError(); err != nil { 743 return nil, 0, false, err 744 } 745 return res, gas, failed, err 746 } 747 748 // Call executes the given transaction on the state for the given block number. 749 // It doesn't make and changes in the state/blockchain and is useful to execute and retrieve values. 750 func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Bytes, error) { 751 result, _, _, err := s.doCall(ctx, args, blockNr, vm.Config{}, 5*time.Second) 752 return (hexutil.Bytes)(result), err 753 } 754 755 // EstimateGas returns an estimate of the amount of gas needed to execute the 756 // given transaction against the current pending block. 757 func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (hexutil.Uint64, error) { 758 // Binary search the gas requirement, as it may be higher than the amount used 759 var ( 760 lo uint64 = params.TxGas - 1 761 hi uint64 762 cap uint64 763 ) 764 if uint64(args.Gas) >= params.TxGas { 765 hi = uint64(args.Gas) 766 } else { 767 // Retrieve the current pending block to act as the gas ceiling 768 block, err := s.b.BlockByNumber(ctx, rpc.PendingBlockNumber) 769 if err != nil { 770 return 0, err 771 } 772 hi = block.GasLimit() 773 } 774 cap = hi 775 776 // Create a helper to check if a gas allowance results in an executable transaction 777 executable := func(gas uint64) bool { 778 args.Gas = hexutil.Uint64(gas) 779 780 _, _, failed, err := s.doCall(ctx, args, rpc.PendingBlockNumber, vm.Config{}, 0) 781 if err != nil || failed { 782 return false 783 } 784 return true 785 } 786 // Execute the binary search and hone in on an executable gas limit 787 for lo+1 < hi { 788 mid := (hi + lo) / 2 789 if !executable(mid) { 790 lo = mid 791 } else { 792 hi = mid 793 } 794 } 795 // Reject the transaction as invalid if it still fails at the highest allowance 796 if hi == cap { 797 if !executable(hi) { 798 return 0, fmt.Errorf("gas required exceeds allowance or always failing transaction") 799 } 800 } 801 return hexutil.Uint64(hi), nil 802 } 803 804 // ExecutionResult groups all structured logs emitted by the EVM 805 // while replaying a transaction in debug mode as well as transaction 806 // execution status, the amount of gas used and the return value 807 type ExecutionResult struct { 808 Gas uint64 `json:"gas"` 809 Failed bool `json:"failed"` 810 ReturnValue string `json:"returnValue"` 811 StructLogs []StructLogRes `json:"structLogs"` 812 } 813 814 // StructLogRes stores a structured log emitted by the EVM while replaying a 815 // transaction in debug mode 816 type StructLogRes struct { 817 Pc uint64 `json:"pc"` 818 Op string `json:"op"` 819 Gas uint64 `json:"gas"` 820 GasCost uint64 `json:"gasCost"` 821 Depth int `json:"depth"` 822 Error error `json:"error,omitempty"` 823 Stack *[]string `json:"stack,omitempty"` 824 Memory *[]string `json:"memory,omitempty"` 825 Storage *map[string]string `json:"storage,omitempty"` 826 } 827 828 // formatLogs formats EVM returned structured logs for json output 829 func FormatLogs(logs []vm.StructLog) []StructLogRes { 830 formatted := make([]StructLogRes, len(logs)) 831 for index, trace := range logs { 832 formatted[index] = StructLogRes{ 833 Pc: trace.Pc, 834 Op: trace.Op.String(), 835 Gas: trace.Gas, 836 GasCost: trace.GasCost, 837 Depth: trace.Depth, 838 Error: trace.Err, 839 } 840 if trace.Stack != nil { 841 stack := make([]string, len(trace.Stack)) 842 for i, stackValue := range trace.Stack { 843 stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32)) 844 } 845 formatted[index].Stack = &stack 846 } 847 if trace.Memory != nil { 848 memory := make([]string, 0, (len(trace.Memory)+31)/32) 849 for i := 0; i+32 <= len(trace.Memory); i += 32 { 850 memory = append(memory, fmt.Sprintf("%x", trace.Memory[i:i+32])) 851 } 852 formatted[index].Memory = &memory 853 } 854 if trace.Storage != nil { 855 storage := make(map[string]string) 856 for i, storageValue := range trace.Storage { 857 storage[fmt.Sprintf("%x", i)] = fmt.Sprintf("%x", storageValue) 858 } 859 formatted[index].Storage = &storage 860 } 861 } 862 return formatted 863 } 864 865 // RPCMarshalBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are 866 // returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain 867 // transaction hashes. 868 func RPCMarshalBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) { 869 head := b.Header() // copies the header once 870 fields := map[string]interface{}{ 871 "number": (*hexutil.Big)(head.Number), 872 "hash": b.Hash(), 873 "parentHash": head.ParentHash, 874 "nonce": head.Nonce, 875 "mixHash": head.MixDigest, 876 "sha3Uncles": head.UncleHash, 877 "logsBloom": head.Bloom, 878 "stateRoot": head.Root, 879 "miner": head.Coinbase, 880 "difficulty": (*hexutil.Big)(head.Difficulty), 881 "extraData": hexutil.Bytes(head.Extra), 882 "size": hexutil.Uint64(b.Size()), 883 "gasLimit": hexutil.Uint64(head.GasLimit), 884 "gasUsed": hexutil.Uint64(head.GasUsed), 885 "timestamp": (*hexutil.Big)(head.Time), 886 "transactionsRoot": head.TxHash, 887 "receiptsRoot": head.ReceiptHash, 888 } 889 890 if inclTx { 891 formatTx := func(tx *types.Transaction) (interface{}, error) { 892 return tx.Hash(), nil 893 } 894 if fullTx { 895 formatTx = func(tx *types.Transaction) (interface{}, error) { 896 return newRPCTransactionFromBlockHash(b, tx.Hash()), nil 897 } 898 } 899 txs := b.Transactions() 900 transactions := make([]interface{}, len(txs)) 901 var err error 902 for i, tx := range txs { 903 if transactions[i], err = formatTx(tx); err != nil { 904 return nil, err 905 } 906 } 907 fields["transactions"] = transactions 908 } 909 910 uncles := b.Uncles() 911 uncleHashes := make([]common.Hash, len(uncles)) 912 for i, uncle := range uncles { 913 uncleHashes[i] = uncle.Hash() 914 } 915 fields["uncles"] = uncleHashes 916 917 return fields, nil 918 } 919 920 // rpcOutputBlock uses the generalized output filler, then adds the total difficulty field, which requires 921 // a `PublicBlockchainAPI`. 922 func (s *PublicBlockChainAPI) rpcOutputBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) { 923 fields, err := RPCMarshalBlock(b, inclTx, fullTx) 924 if err != nil { 925 return nil, err 926 } 927 fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(b.Hash())) 928 return fields, err 929 } 930 931 // RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction 932 type RPCTransaction struct { 933 BlockHash common.Hash `json:"blockHash"` 934 BlockNumber *hexutil.Big `json:"blockNumber"` 935 From common.Address `json:"from"` 936 Gas hexutil.Uint64 `json:"gas"` 937 GasPrice *hexutil.Big `json:"gasPrice"` 938 Hash common.Hash `json:"hash"` 939 Input hexutil.Bytes `json:"input"` 940 Nonce hexutil.Uint64 `json:"nonce"` 941 To *common.Address `json:"to"` 942 TransactionIndex hexutil.Uint `json:"transactionIndex"` 943 Value *hexutil.Big `json:"value"` 944 V *hexutil.Big `json:"v"` 945 R *hexutil.Big `json:"r"` 946 S *hexutil.Big `json:"s"` 947 } 948 949 // newRPCTransaction returns a transaction that will serialize to the RPC 950 // representation, with the given location metadata set (if available). 951 func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64) *RPCTransaction { 952 var signer types.Signer = types.FrontierSigner{} 953 if tx.Protected() { 954 signer = types.NewEIP155Signer(tx.ChainId()) 955 } 956 from, _ := types.Sender(signer, tx) 957 v, r, s := tx.RawSignatureValues() 958 959 result := &RPCTransaction{ 960 From: from, 961 Gas: hexutil.Uint64(tx.Gas()), 962 GasPrice: (*hexutil.Big)(tx.GasPrice()), 963 Hash: tx.Hash(), 964 Input: hexutil.Bytes(tx.Data()), 965 Nonce: hexutil.Uint64(tx.Nonce()), 966 To: tx.To(), 967 Value: (*hexutil.Big)(tx.Value()), 968 V: (*hexutil.Big)(v), 969 R: (*hexutil.Big)(r), 970 S: (*hexutil.Big)(s), 971 } 972 if blockHash != (common.Hash{}) { 973 result.BlockHash = blockHash 974 result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber)) 975 result.TransactionIndex = hexutil.Uint(index) 976 } 977 return result 978 } 979 980 // newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation 981 func newRPCPendingTransaction(tx *types.Transaction) *RPCTransaction { 982 return newRPCTransaction(tx, common.Hash{}, 0, 0) 983 } 984 985 // newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation. 986 func newRPCTransactionFromBlockIndex(b *types.Block, index uint64) *RPCTransaction { 987 txs := b.Transactions() 988 if index >= uint64(len(txs)) { 989 return nil 990 } 991 return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index) 992 } 993 994 // newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index. 995 func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes { 996 txs := b.Transactions() 997 if index >= uint64(len(txs)) { 998 return nil 999 } 1000 blob, _ := rlp.EncodeToBytes(txs[index]) 1001 return blob 1002 } 1003 1004 // newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation. 1005 func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction { 1006 for idx, tx := range b.Transactions() { 1007 if tx.Hash() == hash { 1008 return newRPCTransactionFromBlockIndex(b, uint64(idx)) 1009 } 1010 } 1011 return nil 1012 } 1013 1014 // PublicTransactionPoolAPI exposes methods for the RPC interface 1015 type PublicTransactionPoolAPI struct { 1016 b Backend 1017 nonceLock *AddrLocker 1018 } 1019 1020 // NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool. 1021 func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI { 1022 return &PublicTransactionPoolAPI{b, nonceLock} 1023 } 1024 1025 // GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number. 1026 func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint { 1027 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 1028 n := hexutil.Uint(len(block.Transactions())) 1029 return &n 1030 } 1031 return nil 1032 } 1033 1034 // GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash. 1035 func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint { 1036 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 1037 n := hexutil.Uint(len(block.Transactions())) 1038 return &n 1039 } 1040 return nil 1041 } 1042 1043 // GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index. 1044 func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction { 1045 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 1046 return newRPCTransactionFromBlockIndex(block, uint64(index)) 1047 } 1048 return nil 1049 } 1050 1051 // GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index. 1052 func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction { 1053 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 1054 return newRPCTransactionFromBlockIndex(block, uint64(index)) 1055 } 1056 return nil 1057 } 1058 1059 // GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index. 1060 func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes { 1061 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 1062 return newRPCRawTransactionFromBlockIndex(block, uint64(index)) 1063 } 1064 return nil 1065 } 1066 1067 // GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index. 1068 func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes { 1069 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 1070 return newRPCRawTransactionFromBlockIndex(block, uint64(index)) 1071 } 1072 return nil 1073 } 1074 1075 // GetTransactionCount returns the number of transactions the given address has sent for the given block number 1076 func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) { 1077 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 1078 if state == nil || err != nil { 1079 return nil, err 1080 } 1081 nonce := state.GetNonce(address) 1082 return (*hexutil.Uint64)(&nonce), state.Error() 1083 } 1084 1085 // GetTransactionByHash returns the transaction for the given hash 1086 func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) *RPCTransaction { 1087 // Try to return an already finalized transaction 1088 if tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash); tx != nil { 1089 return newRPCTransaction(tx, blockHash, blockNumber, index) 1090 } 1091 // No finalized transaction, try to retrieve it from the pool 1092 if tx := s.b.GetPoolTransaction(hash); tx != nil { 1093 return newRPCPendingTransaction(tx) 1094 } 1095 // Transaction unknown, return as such 1096 return nil 1097 } 1098 1099 // GetRawTransactionByHash returns the bytes of the transaction for the given hash. 1100 func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) { 1101 var tx *types.Transaction 1102 1103 // Retrieve a finalized transaction, or a pooled otherwise 1104 if tx, _, _, _ = rawdb.ReadTransaction(s.b.ChainDb(), hash); tx == nil { 1105 if tx = s.b.GetPoolTransaction(hash); tx == nil { 1106 // Transaction not found anywhere, abort 1107 return nil, nil 1108 } 1109 } 1110 // Serialize to RLP and return 1111 return rlp.EncodeToBytes(tx) 1112 } 1113 1114 // GetTransactionReceipt returns the transaction receipt for the given transaction hash. 1115 func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) { 1116 tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash) 1117 if tx == nil { 1118 return nil, nil 1119 } 1120 receipts, err := s.b.GetReceipts(ctx, blockHash) 1121 if err != nil { 1122 return nil, err 1123 } 1124 if len(receipts) <= int(index) { 1125 return nil, nil 1126 } 1127 receipt := receipts[index] 1128 1129 var signer types.Signer = types.FrontierSigner{} 1130 if tx.Protected() { 1131 signer = types.NewEIP155Signer(tx.ChainId()) 1132 } 1133 from, _ := types.Sender(signer, tx) 1134 1135 fields := map[string]interface{}{ 1136 "blockHash": blockHash, 1137 "blockNumber": hexutil.Uint64(blockNumber), 1138 "transactionHash": hash, 1139 "transactionIndex": hexutil.Uint64(index), 1140 "from": from, 1141 "to": tx.To(), 1142 "gasUsed": hexutil.Uint64(receipt.GasUsed), 1143 "cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed), 1144 "contractAddress": nil, 1145 "logs": receipt.Logs, 1146 "logsBloom": receipt.Bloom, 1147 } 1148 1149 // Assign receipt status or post state. 1150 if len(receipt.PostState) > 0 { 1151 fields["root"] = hexutil.Bytes(receipt.PostState) 1152 } else { 1153 fields["status"] = hexutil.Uint(receipt.Status) 1154 } 1155 if receipt.Logs == nil { 1156 fields["logs"] = [][]*types.Log{} 1157 } 1158 // If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation 1159 if receipt.ContractAddress != (common.Address{}) { 1160 fields["contractAddress"] = receipt.ContractAddress 1161 } 1162 return fields, nil 1163 } 1164 1165 // sign is a helper function that signs a transaction with the private key of the given address. 1166 func (s *PublicTransactionPoolAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) { 1167 // Look up the wallet containing the requested signer 1168 account := accounts.Account{Address: addr} 1169 1170 wallet, err := s.b.AccountManager().Find(account) 1171 if err != nil { 1172 return nil, err 1173 } 1174 // Request the wallet to sign the transaction 1175 var chainID *big.Int 1176 if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) { 1177 chainID = config.ChainID 1178 } 1179 return wallet.SignTx(account, tx, chainID) 1180 } 1181 1182 // SendTxArgs represents the arguments to sumbit a new transaction into the transaction pool. 1183 type SendTxArgs struct { 1184 From common.Address `json:"from"` 1185 To *common.Address `json:"to"` 1186 Gas *hexutil.Uint64 `json:"gas"` 1187 GasPrice *hexutil.Big `json:"gasPrice"` 1188 Value *hexutil.Big `json:"value"` 1189 Nonce *hexutil.Uint64 `json:"nonce"` 1190 // We accept "data" and "input" for backwards-compatibility reasons. "input" is the 1191 // newer name and should be preferred by clients. 1192 Data *hexutil.Bytes `json:"data"` 1193 Input *hexutil.Bytes `json:"input"` 1194 } 1195 1196 // setDefaults is a helper function that fills in default values for unspecified tx fields. 1197 func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error { 1198 if args.Gas == nil { 1199 args.Gas = new(hexutil.Uint64) 1200 *(*uint64)(args.Gas) = 90000 1201 } 1202 if args.GasPrice == nil { 1203 price, err := b.SuggestPrice(ctx) 1204 if err != nil { 1205 return err 1206 } 1207 args.GasPrice = (*hexutil.Big)(price) 1208 } 1209 if args.Value == nil { 1210 args.Value = new(hexutil.Big) 1211 } 1212 if args.Nonce == nil { 1213 nonce, err := b.GetPoolNonce(ctx, args.From) 1214 if err != nil { 1215 return err 1216 } 1217 args.Nonce = (*hexutil.Uint64)(&nonce) 1218 } 1219 if args.Data != nil && args.Input != nil && !bytes.Equal(*args.Data, *args.Input) { 1220 return errors.New(`Both "data" and "input" are set and not equal. Please use "input" to pass transaction call data.`) 1221 } 1222 if args.To == nil { 1223 // Contract creation 1224 var input []byte 1225 if args.Data != nil { 1226 input = *args.Data 1227 } else if args.Input != nil { 1228 input = *args.Input 1229 } 1230 if len(input) == 0 { 1231 return errors.New(`contract creation without any data provided`) 1232 } 1233 } 1234 return nil 1235 } 1236 1237 func (args *SendTxArgs) toTransaction() *types.Transaction { 1238 var input []byte 1239 if args.Data != nil { 1240 input = *args.Data 1241 } else if args.Input != nil { 1242 input = *args.Input 1243 } 1244 if args.To == nil { 1245 return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input) 1246 } 1247 return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input) 1248 } 1249 1250 // submitTransaction is a helper function that submits tx to txPool and logs a message. 1251 func submitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) { 1252 if err := b.SendTx(ctx, tx); err != nil { 1253 return common.Hash{}, err 1254 } 1255 if tx.To() == nil { 1256 signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number()) 1257 from, err := types.Sender(signer, tx) 1258 if err != nil { 1259 return common.Hash{}, err 1260 } 1261 addr := crypto.CreateAddress(from, tx.Nonce()) 1262 log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex()) 1263 } else { 1264 log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To()) 1265 } 1266 return tx.Hash(), nil 1267 } 1268 1269 // SendTransaction creates a transaction for the given argument, sign it and submit it to the 1270 // transaction pool. 1271 func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args SendTxArgs) (common.Hash, error) { 1272 1273 // Look up the wallet containing the requested signer 1274 account := accounts.Account{Address: args.From} 1275 1276 wallet, err := s.b.AccountManager().Find(account) 1277 if err != nil { 1278 return common.Hash{}, err 1279 } 1280 1281 if args.Nonce == nil { 1282 // Hold the addresse's mutex around signing to prevent concurrent assignment of 1283 // the same nonce to multiple accounts. 1284 s.nonceLock.LockAddr(args.From) 1285 defer s.nonceLock.UnlockAddr(args.From) 1286 } 1287 1288 // Set some sanity defaults and terminate on failure 1289 if err := args.setDefaults(ctx, s.b); err != nil { 1290 return common.Hash{}, err 1291 } 1292 // Assemble the transaction and sign with the wallet 1293 tx := args.toTransaction() 1294 1295 var chainID *big.Int 1296 if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) { 1297 chainID = config.ChainID 1298 } 1299 signed, err := wallet.SignTx(account, tx, chainID) 1300 if err != nil { 1301 return common.Hash{}, err 1302 } 1303 return submitTransaction(ctx, s.b, signed) 1304 } 1305 1306 // SendRawTransaction will add the signed transaction to the transaction pool. 1307 // The sender is responsible for signing the transaction and using the correct nonce. 1308 func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) { 1309 tx := new(types.Transaction) 1310 if err := rlp.DecodeBytes(encodedTx, tx); err != nil { 1311 return common.Hash{}, err 1312 } 1313 return submitTransaction(ctx, s.b, tx) 1314 } 1315 1316 // Sign calculates an ECDSA signature for: 1317 // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message). 1318 // 1319 // Note, the produced signature conforms to the secp256k1 curve R, S and V values, 1320 // where the V value will be 27 or 28 for legacy reasons. 1321 // 1322 // The account associated with addr must be unlocked. 1323 // 1324 // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign 1325 func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) { 1326 // Look up the wallet containing the requested signer 1327 account := accounts.Account{Address: addr} 1328 1329 wallet, err := s.b.AccountManager().Find(account) 1330 if err != nil { 1331 return nil, err 1332 } 1333 // Sign the requested hash with the wallet 1334 signature, err := wallet.SignHash(account, signHash(data)) 1335 if err == nil { 1336 signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper 1337 } 1338 return signature, err 1339 } 1340 1341 // SignTransactionResult represents a RLP encoded signed transaction. 1342 type SignTransactionResult struct { 1343 Raw hexutil.Bytes `json:"raw"` 1344 Tx *types.Transaction `json:"tx"` 1345 } 1346 1347 // SignTransaction will sign the given transaction with the from account. 1348 // The node needs to have the private key of the account corresponding with 1349 // the given from address and it needs to be unlocked. 1350 func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) { 1351 if args.Gas == nil { 1352 return nil, fmt.Errorf("gas not specified") 1353 } 1354 if args.GasPrice == nil { 1355 return nil, fmt.Errorf("gasPrice not specified") 1356 } 1357 if args.Nonce == nil { 1358 return nil, fmt.Errorf("nonce not specified") 1359 } 1360 if err := args.setDefaults(ctx, s.b); err != nil { 1361 return nil, err 1362 } 1363 tx, err := s.sign(args.From, args.toTransaction()) 1364 if err != nil { 1365 return nil, err 1366 } 1367 data, err := rlp.EncodeToBytes(tx) 1368 if err != nil { 1369 return nil, err 1370 } 1371 return &SignTransactionResult{data, tx}, nil 1372 } 1373 1374 // PendingTransactions returns the transactions that are in the transaction pool 1375 // and have a from address that is one of the accounts this node manages. 1376 func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) { 1377 pending, err := s.b.GetPoolTransactions() 1378 if err != nil { 1379 return nil, err 1380 } 1381 accounts := make(map[common.Address]struct{}) 1382 for _, wallet := range s.b.AccountManager().Wallets() { 1383 for _, account := range wallet.Accounts() { 1384 accounts[account.Address] = struct{}{} 1385 } 1386 } 1387 transactions := make([]*RPCTransaction, 0, len(pending)) 1388 for _, tx := range pending { 1389 var signer types.Signer = types.HomesteadSigner{} 1390 if tx.Protected() { 1391 signer = types.NewEIP155Signer(tx.ChainId()) 1392 } 1393 from, _ := types.Sender(signer, tx) 1394 if _, exists := accounts[from]; exists { 1395 transactions = append(transactions, newRPCPendingTransaction(tx)) 1396 } 1397 } 1398 return transactions, nil 1399 } 1400 1401 // Resend accepts an existing transaction and a new gas price and limit. It will remove 1402 // the given transaction from the pool and reinsert it with the new gas price and limit. 1403 func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) { 1404 if sendArgs.Nonce == nil { 1405 return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec") 1406 } 1407 if err := sendArgs.setDefaults(ctx, s.b); err != nil { 1408 return common.Hash{}, err 1409 } 1410 matchTx := sendArgs.toTransaction() 1411 pending, err := s.b.GetPoolTransactions() 1412 if err != nil { 1413 return common.Hash{}, err 1414 } 1415 1416 for _, p := range pending { 1417 var signer types.Signer = types.HomesteadSigner{} 1418 if p.Protected() { 1419 signer = types.NewEIP155Signer(p.ChainId()) 1420 } 1421 wantSigHash := signer.Hash(matchTx) 1422 1423 if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash { 1424 // Match. Re-sign and send the transaction. 1425 if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 { 1426 sendArgs.GasPrice = gasPrice 1427 } 1428 if gasLimit != nil && *gasLimit != 0 { 1429 sendArgs.Gas = gasLimit 1430 } 1431 signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction()) 1432 if err != nil { 1433 return common.Hash{}, err 1434 } 1435 if err = s.b.SendTx(ctx, signedTx); err != nil { 1436 return common.Hash{}, err 1437 } 1438 return signedTx.Hash(), nil 1439 } 1440 } 1441 1442 return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash()) 1443 } 1444 1445 // PublicDebugAPI is the collection of Ethereum APIs exposed over the public 1446 // debugging endpoint. 1447 type PublicDebugAPI struct { 1448 b Backend 1449 } 1450 1451 // NewPublicDebugAPI creates a new API definition for the public debug methods 1452 // of the Ethereum service. 1453 func NewPublicDebugAPI(b Backend) *PublicDebugAPI { 1454 return &PublicDebugAPI{b: b} 1455 } 1456 1457 // GetBlockRlp retrieves the RLP encoded for of a single block. 1458 func (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) { 1459 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1460 if block == nil { 1461 return "", fmt.Errorf("block #%d not found", number) 1462 } 1463 encoded, err := rlp.EncodeToBytes(block) 1464 if err != nil { 1465 return "", err 1466 } 1467 return fmt.Sprintf("%x", encoded), nil 1468 } 1469 1470 // PrintBlock retrieves a block and returns its pretty printed form. 1471 func (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) { 1472 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1473 if block == nil { 1474 return "", fmt.Errorf("block #%d not found", number) 1475 } 1476 return spew.Sdump(block), nil 1477 } 1478 1479 // SeedHash retrieves the seed hash of a block. 1480 func (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) { 1481 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1482 if block == nil { 1483 return "", fmt.Errorf("block #%d not found", number) 1484 } 1485 return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil 1486 } 1487 1488 // PrivateDebugAPI is the collection of Ethereum APIs exposed over the private 1489 // debugging endpoint. 1490 type PrivateDebugAPI struct { 1491 b Backend 1492 } 1493 1494 // NewPrivateDebugAPI creates a new API definition for the private debug methods 1495 // of the Ethereum service. 1496 func NewPrivateDebugAPI(b Backend) *PrivateDebugAPI { 1497 return &PrivateDebugAPI{b: b} 1498 } 1499 1500 // ChaindbProperty returns leveldb properties of the chain database. 1501 func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) { 1502 ldb, ok := api.b.ChainDb().(interface { 1503 LDB() *leveldb.DB 1504 }) 1505 if !ok { 1506 return "", fmt.Errorf("chaindbProperty does not work for memory databases") 1507 } 1508 if property == "" { 1509 property = "leveldb.stats" 1510 } else if !strings.HasPrefix(property, "leveldb.") { 1511 property = "leveldb." + property 1512 } 1513 return ldb.LDB().GetProperty(property) 1514 } 1515 1516 func (api *PrivateDebugAPI) ChaindbCompact() error { 1517 ldb, ok := api.b.ChainDb().(interface { 1518 LDB() *leveldb.DB 1519 }) 1520 if !ok { 1521 return fmt.Errorf("chaindbCompact does not work for memory databases") 1522 } 1523 for b := byte(0); b < 255; b++ { 1524 log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1)) 1525 err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}}) 1526 if err != nil { 1527 log.Error("Database compaction failed", "err", err) 1528 return err 1529 } 1530 } 1531 return nil 1532 } 1533 1534 // SetHead rewinds the head of the blockchain to a previous block. 1535 func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) { 1536 api.b.SetHead(uint64(number)) 1537 } 1538 1539 // PublicNetAPI offers network related RPC methods 1540 type PublicNetAPI struct { 1541 net *p2p.Server 1542 networkVersion uint64 1543 } 1544 1545 // NewPublicNetAPI creates a new net API instance. 1546 func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI { 1547 return &PublicNetAPI{net, networkVersion} 1548 } 1549 1550 // Listening returns an indication if the node is listening for network connections. 1551 func (s *PublicNetAPI) Listening() bool { 1552 return true // always listening 1553 } 1554 1555 // PeerCount returns the number of connected peers 1556 func (s *PublicNetAPI) PeerCount() hexutil.Uint { 1557 return hexutil.Uint(s.net.PeerCount()) 1558 } 1559 1560 // Version returns the current ethereum protocol version. 1561 func (s *PublicNetAPI) Version() string { 1562 return fmt.Sprintf("%d", s.networkVersion) 1563 }