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