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