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