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