github.com/luckypickle/go-ethereum-vet@v1.14.2/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/luckypickle/go-ethereum-vet/accounts" 30 "github.com/luckypickle/go-ethereum-vet/accounts/keystore" 31 "github.com/luckypickle/go-ethereum-vet/common" 32 "github.com/luckypickle/go-ethereum-vet/common/hexutil" 33 "github.com/luckypickle/go-ethereum-vet/common/math" 34 "github.com/luckypickle/go-ethereum-vet/consensus/ethash" 35 "github.com/luckypickle/go-ethereum-vet/core" 36 "github.com/luckypickle/go-ethereum-vet/core/rawdb" 37 "github.com/luckypickle/go-ethereum-vet/core/types" 38 "github.com/luckypickle/go-ethereum-vet/core/vm" 39 "github.com/luckypickle/go-ethereum-vet/crypto" 40 "github.com/luckypickle/go-ethereum-vet/log" 41 "github.com/luckypickle/go-ethereum-vet/p2p" 42 "github.com/luckypickle/go-ethereum-vet/params" 43 "github.com/luckypickle/go-ethereum-vet/rlp" 44 "github.com/luckypickle/go-ethereum-vet/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 func (s *PrivateAccountAPI) signTransaction(ctx context.Context, args SendTxArgs, passwd string) (*types.Transaction, error) { 343 // Look up the wallet containing the requested signer 344 account := accounts.Account{Address: args.From} 345 wallet, err := s.am.Find(account) 346 if err != nil { 347 return nil, err 348 } 349 // Set some sanity defaults and terminate on failure 350 if err := args.setDefaults(ctx, s.b); err != nil { 351 return nil, err 352 } 353 // Assemble the transaction and sign with the wallet 354 tx := args.toTransaction() 355 356 var chainID *big.Int 357 if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) { 358 chainID = config.ChainID 359 } 360 return wallet.SignTxWithPassphrase(account, passwd, tx, chainID) 361 } 362 363 // SendTransaction will create a transaction from the given arguments and 364 // tries to sign it with the key associated with args.To. If the given passwd isn't 365 // able to decrypt the key it fails. 366 func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) { 367 if args.Nonce == nil { 368 // Hold the addresse's mutex around signing to prevent concurrent assignment of 369 // the same nonce to multiple accounts. 370 s.nonceLock.LockAddr(args.From) 371 defer s.nonceLock.UnlockAddr(args.From) 372 } 373 signed, err := s.signTransaction(ctx, args, passwd) 374 if err != nil { 375 return common.Hash{}, err 376 } 377 return submitTransaction(ctx, s.b, signed) 378 } 379 380 // SignTransaction will create a transaction from the given arguments and 381 // tries to sign it with the key associated with args.To. If the given passwd isn't 382 // able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast 383 // to other nodes 384 func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args SendTxArgs, passwd string) (*SignTransactionResult, error) { 385 // No need to obtain the noncelock mutex, since we won't be sending this 386 // tx into the transaction pool, but right back to the user 387 if args.Gas == nil { 388 return nil, fmt.Errorf("gas not specified") 389 } 390 if args.GasPrice == nil { 391 return nil, fmt.Errorf("gasPrice not specified") 392 } 393 if args.Nonce == nil { 394 return nil, fmt.Errorf("nonce not specified") 395 } 396 signed, err := s.signTransaction(ctx, args, passwd) 397 if err != nil { 398 return nil, err 399 } 400 data, err := rlp.EncodeToBytes(signed) 401 if err != nil { 402 return nil, err 403 } 404 return &SignTransactionResult{data, signed}, nil 405 } 406 407 // signHash is a helper function that calculates a hash for the given message that can be 408 // safely used to calculate a signature from. 409 // 410 // The hash is calulcated as 411 // 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/luckypickle/go-ethereum-vet/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/luckypickle/go-ethereum-vet/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 // BlockNumber returns the block number of the chain head. 490 func (s *PublicBlockChainAPI) BlockNumber() hexutil.Uint64 { 491 header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available 492 return hexutil.Uint64(header.Number.Uint64()) 493 } 494 495 // GetBalance returns the amount of wei for the given address in the state of the 496 // given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta 497 // block numbers are also allowed. 498 func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Big, error) { 499 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 500 if state == nil || err != nil { 501 return nil, err 502 } 503 return (*hexutil.Big)(state.GetBalance(address)), state.Error() 504 } 505 506 // GetBlockByNumber returns the requested block. When blockNr is -1 the chain head is returned. When fullTx is true all 507 // transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 508 func (s *PublicBlockChainAPI) GetBlockByNumber(ctx context.Context, blockNr rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) { 509 block, err := s.b.BlockByNumber(ctx, blockNr) 510 if block != nil { 511 response, err := s.rpcOutputBlock(block, true, fullTx) 512 if err == nil && blockNr == rpc.PendingBlockNumber { 513 // Pending blocks need to nil out a few fields 514 for _, field := range []string{"hash", "nonce", "miner"} { 515 response[field] = nil 516 } 517 } 518 return response, err 519 } 520 return nil, err 521 } 522 523 // GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full 524 // detail, otherwise only the transaction hash is returned. 525 func (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, blockHash common.Hash, fullTx bool) (map[string]interface{}, error) { 526 block, err := s.b.GetBlock(ctx, blockHash) 527 if block != nil { 528 return s.rpcOutputBlock(block, true, fullTx) 529 } 530 return nil, err 531 } 532 533 // GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true 534 // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 535 func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) { 536 block, err := s.b.BlockByNumber(ctx, blockNr) 537 if block != nil { 538 uncles := block.Uncles() 539 if index >= hexutil.Uint(len(uncles)) { 540 log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index) 541 return nil, nil 542 } 543 block = types.NewBlockWithHeader(uncles[index]) 544 return s.rpcOutputBlock(block, false, false) 545 } 546 return nil, err 547 } 548 549 // GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true 550 // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 551 func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) { 552 block, err := s.b.GetBlock(ctx, blockHash) 553 if block != nil { 554 uncles := block.Uncles() 555 if index >= hexutil.Uint(len(uncles)) { 556 log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index) 557 return nil, nil 558 } 559 block = types.NewBlockWithHeader(uncles[index]) 560 return s.rpcOutputBlock(block, false, false) 561 } 562 return nil, err 563 } 564 565 // GetUncleCountByBlockNumber returns number of uncles in the block for the given block number 566 func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint { 567 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 568 n := hexutil.Uint(len(block.Uncles())) 569 return &n 570 } 571 return nil 572 } 573 574 // GetUncleCountByBlockHash returns number of uncles in the block for the given block hash 575 func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint { 576 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 577 n := hexutil.Uint(len(block.Uncles())) 578 return &n 579 } 580 return nil 581 } 582 583 // GetCode returns the code stored at the given address in the state for the given block number. 584 func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (hexutil.Bytes, error) { 585 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 586 if state == nil || err != nil { 587 return nil, err 588 } 589 code := state.GetCode(address) 590 return code, state.Error() 591 } 592 593 // GetStorageAt returns the storage from the state at the given address, key and 594 // block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block 595 // numbers are also allowed. 596 func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNr rpc.BlockNumber) (hexutil.Bytes, error) { 597 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 598 if state == nil || err != nil { 599 return nil, err 600 } 601 res := state.GetState(address, common.HexToHash(key)) 602 return res[:], state.Error() 603 } 604 605 // CallArgs represents the arguments for a call. 606 type CallArgs struct { 607 From common.Address `json:"from"` 608 To *common.Address `json:"to"` 609 Gas hexutil.Uint64 `json:"gas"` 610 GasPrice hexutil.Big `json:"gasPrice"` 611 Value hexutil.Big `json:"value"` 612 Data hexutil.Bytes `json:"data"` 613 } 614 615 func (s *PublicBlockChainAPI) doCall(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber, vmCfg vm.Config, timeout time.Duration) ([]byte, uint64, bool, error) { 616 defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now()) 617 618 state, header, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 619 if state == nil || err != nil { 620 return nil, 0, false, err 621 } 622 // Set sender address or use a default if none specified 623 addr := args.From 624 if addr == (common.Address{}) { 625 if wallets := s.b.AccountManager().Wallets(); len(wallets) > 0 { 626 if accounts := wallets[0].Accounts(); len(accounts) > 0 { 627 addr = accounts[0].Address 628 } 629 } 630 } 631 // Set default gas & gas price if none were set 632 gas, gasPrice := uint64(args.Gas), args.GasPrice.ToInt() 633 if gas == 0 { 634 gas = math.MaxUint64 / 2 635 } 636 if gasPrice.Sign() == 0 { 637 gasPrice = new(big.Int).SetUint64(defaultGasPrice) 638 } 639 640 // Create new call message 641 msg := types.NewMessage(addr, args.To, 0, args.Value.ToInt(), gas, gasPrice, args.Data, false) 642 643 // Setup context so it may be cancelled the call has completed 644 // or, in case of unmetered gas, setup a context with a timeout. 645 var cancel context.CancelFunc 646 if timeout > 0 { 647 ctx, cancel = context.WithTimeout(ctx, timeout) 648 } else { 649 ctx, cancel = context.WithCancel(ctx) 650 } 651 // Make sure the context is cancelled when the call has completed 652 // this makes sure resources are cleaned up. 653 defer cancel() 654 655 // Get a new instance of the EVM. 656 evm, vmError, err := s.b.GetEVM(ctx, msg, state, header, vmCfg) 657 if err != nil { 658 return nil, 0, false, err 659 } 660 // Wait for the context to be done and cancel the evm. Even if the 661 // EVM has finished, cancelling may be done (repeatedly) 662 go func() { 663 <-ctx.Done() 664 evm.Cancel() 665 }() 666 667 // Setup the gas pool (also for unmetered requests) 668 // and apply the message. 669 gp := new(core.GasPool).AddGas(math.MaxUint64) 670 res, gas, failed, err := core.ApplyMessage(evm, msg, gp) 671 if err := vmError(); err != nil { 672 return nil, 0, false, err 673 } 674 return res, gas, failed, err 675 } 676 677 // Call executes the given transaction on the state for the given block number. 678 // It doesn't make and changes in the state/blockchain and is useful to execute and retrieve values. 679 func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Bytes, error) { 680 result, _, _, err := s.doCall(ctx, args, blockNr, vm.Config{}, 5*time.Second) 681 return (hexutil.Bytes)(result), err 682 } 683 684 // EstimateGas returns an estimate of the amount of gas needed to execute the 685 // given transaction against the current pending block. 686 func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (hexutil.Uint64, error) { 687 // Binary search the gas requirement, as it may be higher than the amount used 688 var ( 689 lo uint64 = params.TxGas - 1 690 hi uint64 691 cap uint64 692 ) 693 if uint64(args.Gas) >= params.TxGas { 694 hi = uint64(args.Gas) 695 } else { 696 // Retrieve the current pending block to act as the gas ceiling 697 block, err := s.b.BlockByNumber(ctx, rpc.PendingBlockNumber) 698 if err != nil { 699 return 0, err 700 } 701 hi = block.GasLimit() 702 } 703 cap = hi 704 705 // Create a helper to check if a gas allowance results in an executable transaction 706 executable := func(gas uint64) bool { 707 args.Gas = hexutil.Uint64(gas) 708 709 _, _, failed, err := s.doCall(ctx, args, rpc.PendingBlockNumber, vm.Config{}, 0) 710 if err != nil || failed { 711 return false 712 } 713 return true 714 } 715 // Execute the binary search and hone in on an executable gas limit 716 for lo+1 < hi { 717 mid := (hi + lo) / 2 718 if !executable(mid) { 719 lo = mid 720 } else { 721 hi = mid 722 } 723 } 724 // Reject the transaction as invalid if it still fails at the highest allowance 725 if hi == cap { 726 if !executable(hi) { 727 return 0, fmt.Errorf("gas required exceeds allowance or always failing transaction") 728 } 729 } 730 return hexutil.Uint64(hi), nil 731 } 732 733 // ExecutionResult groups all structured logs emitted by the EVM 734 // while replaying a transaction in debug mode as well as transaction 735 // execution status, the amount of gas used and the return value 736 type ExecutionResult struct { 737 Gas uint64 `json:"gas"` 738 Failed bool `json:"failed"` 739 ReturnValue string `json:"returnValue"` 740 StructLogs []StructLogRes `json:"structLogs"` 741 } 742 743 // StructLogRes stores a structured log emitted by the EVM while replaying a 744 // transaction in debug mode 745 type StructLogRes struct { 746 Pc uint64 `json:"pc"` 747 Op string `json:"op"` 748 Gas uint64 `json:"gas"` 749 GasCost uint64 `json:"gasCost"` 750 Depth int `json:"depth"` 751 Error error `json:"error,omitempty"` 752 Stack *[]string `json:"stack,omitempty"` 753 Memory *[]string `json:"memory,omitempty"` 754 Storage *map[string]string `json:"storage,omitempty"` 755 } 756 757 // formatLogs formats EVM returned structured logs for json output 758 func FormatLogs(logs []vm.StructLog) []StructLogRes { 759 formatted := make([]StructLogRes, len(logs)) 760 for index, trace := range logs { 761 formatted[index] = StructLogRes{ 762 Pc: trace.Pc, 763 Op: trace.Op.String(), 764 Gas: trace.Gas, 765 GasCost: trace.GasCost, 766 Depth: trace.Depth, 767 Error: trace.Err, 768 } 769 if trace.Stack != nil { 770 stack := make([]string, len(trace.Stack)) 771 for i, stackValue := range trace.Stack { 772 stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32)) 773 } 774 formatted[index].Stack = &stack 775 } 776 if trace.Memory != nil { 777 memory := make([]string, 0, (len(trace.Memory)+31)/32) 778 for i := 0; i+32 <= len(trace.Memory); i += 32 { 779 memory = append(memory, fmt.Sprintf("%x", trace.Memory[i:i+32])) 780 } 781 formatted[index].Memory = &memory 782 } 783 if trace.Storage != nil { 784 storage := make(map[string]string) 785 for i, storageValue := range trace.Storage { 786 storage[fmt.Sprintf("%x", i)] = fmt.Sprintf("%x", storageValue) 787 } 788 formatted[index].Storage = &storage 789 } 790 } 791 return formatted 792 } 793 794 // RPCMarshalBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are 795 // returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain 796 // transaction hashes. 797 func RPCMarshalBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) { 798 head := b.Header() // copies the header once 799 fields := map[string]interface{}{ 800 "number": (*hexutil.Big)(head.Number), 801 "hash": b.Hash(), 802 "parentHash": head.ParentHash, 803 "nonce": head.Nonce, 804 "mixHash": head.MixDigest, 805 "sha3Uncles": head.UncleHash, 806 "logsBloom": head.Bloom, 807 "stateRoot": head.Root, 808 "miner": head.Coinbase, 809 "difficulty": (*hexutil.Big)(head.Difficulty), 810 "extraData": hexutil.Bytes(head.Extra), 811 "size": hexutil.Uint64(b.Size()), 812 "gasLimit": hexutil.Uint64(head.GasLimit), 813 "gasUsed": hexutil.Uint64(head.GasUsed), 814 "timestamp": (*hexutil.Big)(head.Time), 815 "transactionsRoot": head.TxHash, 816 "receiptsRoot": head.ReceiptHash, 817 } 818 819 if inclTx { 820 formatTx := func(tx *types.Transaction) (interface{}, error) { 821 return tx.Hash(), nil 822 } 823 if fullTx { 824 formatTx = func(tx *types.Transaction) (interface{}, error) { 825 return newRPCTransactionFromBlockHash(b, tx.Hash()), nil 826 } 827 } 828 txs := b.Transactions() 829 transactions := make([]interface{}, len(txs)) 830 var err error 831 for i, tx := range txs { 832 if transactions[i], err = formatTx(tx); err != nil { 833 return nil, err 834 } 835 } 836 fields["transactions"] = transactions 837 } 838 839 uncles := b.Uncles() 840 uncleHashes := make([]common.Hash, len(uncles)) 841 for i, uncle := range uncles { 842 uncleHashes[i] = uncle.Hash() 843 } 844 fields["uncles"] = uncleHashes 845 846 return fields, nil 847 } 848 849 // rpcOutputBlock uses the generalized output filler, then adds the total difficulty field, which requires 850 // a `PublicBlockchainAPI`. 851 func (s *PublicBlockChainAPI) rpcOutputBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) { 852 fields, err := RPCMarshalBlock(b, inclTx, fullTx) 853 if err != nil { 854 return nil, err 855 } 856 fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(b.Hash())) 857 return fields, err 858 } 859 860 // RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction 861 type RPCTransaction struct { 862 BlockHash common.Hash `json:"blockHash"` 863 BlockNumber *hexutil.Big `json:"blockNumber"` 864 From common.Address `json:"from"` 865 Gas hexutil.Uint64 `json:"gas"` 866 GasPrice *hexutil.Big `json:"gasPrice"` 867 Hash common.Hash `json:"hash"` 868 Input hexutil.Bytes `json:"input"` 869 Nonce hexutil.Uint64 `json:"nonce"` 870 To *common.Address `json:"to"` 871 TransactionIndex hexutil.Uint `json:"transactionIndex"` 872 Value *hexutil.Big `json:"value"` 873 V *hexutil.Big `json:"v"` 874 R *hexutil.Big `json:"r"` 875 S *hexutil.Big `json:"s"` 876 } 877 878 // newRPCTransaction returns a transaction that will serialize to the RPC 879 // representation, with the given location metadata set (if available). 880 func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64) *RPCTransaction { 881 var signer types.Signer = types.FrontierSigner{} 882 if tx.Protected() { 883 signer = types.NewEIP155Signer(tx.ChainId()) 884 } 885 from, _ := types.Sender(signer, tx) 886 v, r, s := tx.RawSignatureValues() 887 888 result := &RPCTransaction{ 889 From: from, 890 Gas: hexutil.Uint64(tx.Gas()), 891 GasPrice: (*hexutil.Big)(tx.GasPrice()), 892 Hash: tx.Hash(), 893 Input: hexutil.Bytes(tx.Data()), 894 Nonce: hexutil.Uint64(tx.Nonce()), 895 To: tx.To(), 896 Value: (*hexutil.Big)(tx.Value()), 897 V: (*hexutil.Big)(v), 898 R: (*hexutil.Big)(r), 899 S: (*hexutil.Big)(s), 900 } 901 if blockHash != (common.Hash{}) { 902 result.BlockHash = blockHash 903 result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber)) 904 result.TransactionIndex = hexutil.Uint(index) 905 } 906 return result 907 } 908 909 // newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation 910 func newRPCPendingTransaction(tx *types.Transaction) *RPCTransaction { 911 return newRPCTransaction(tx, common.Hash{}, 0, 0) 912 } 913 914 // newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation. 915 func newRPCTransactionFromBlockIndex(b *types.Block, index uint64) *RPCTransaction { 916 txs := b.Transactions() 917 if index >= uint64(len(txs)) { 918 return nil 919 } 920 return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index) 921 } 922 923 // newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index. 924 func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes { 925 txs := b.Transactions() 926 if index >= uint64(len(txs)) { 927 return nil 928 } 929 blob, _ := rlp.EncodeToBytes(txs[index]) 930 return blob 931 } 932 933 // newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation. 934 func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction { 935 for idx, tx := range b.Transactions() { 936 if tx.Hash() == hash { 937 return newRPCTransactionFromBlockIndex(b, uint64(idx)) 938 } 939 } 940 return nil 941 } 942 943 // PublicTransactionPoolAPI exposes methods for the RPC interface 944 type PublicTransactionPoolAPI struct { 945 b Backend 946 nonceLock *AddrLocker 947 } 948 949 // NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool. 950 func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI { 951 return &PublicTransactionPoolAPI{b, nonceLock} 952 } 953 954 // GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number. 955 func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint { 956 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 957 n := hexutil.Uint(len(block.Transactions())) 958 return &n 959 } 960 return nil 961 } 962 963 // GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash. 964 func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint { 965 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 966 n := hexutil.Uint(len(block.Transactions())) 967 return &n 968 } 969 return nil 970 } 971 972 // GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index. 973 func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction { 974 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 975 return newRPCTransactionFromBlockIndex(block, uint64(index)) 976 } 977 return nil 978 } 979 980 // GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index. 981 func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction { 982 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 983 return newRPCTransactionFromBlockIndex(block, uint64(index)) 984 } 985 return nil 986 } 987 988 // GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index. 989 func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes { 990 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 991 return newRPCRawTransactionFromBlockIndex(block, uint64(index)) 992 } 993 return nil 994 } 995 996 // GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index. 997 func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes { 998 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 999 return newRPCRawTransactionFromBlockIndex(block, uint64(index)) 1000 } 1001 return nil 1002 } 1003 1004 // GetTransactionCount returns the number of transactions the given address has sent for the given block number 1005 func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) { 1006 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 1007 if state == nil || err != nil { 1008 return nil, err 1009 } 1010 nonce := state.GetNonce(address) 1011 return (*hexutil.Uint64)(&nonce), state.Error() 1012 } 1013 1014 // GetTransactionByHash returns the transaction for the given hash 1015 func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) *RPCTransaction { 1016 // Try to return an already finalized transaction 1017 if tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash); tx != nil { 1018 return newRPCTransaction(tx, blockHash, blockNumber, index) 1019 } 1020 // No finalized transaction, try to retrieve it from the pool 1021 if tx := s.b.GetPoolTransaction(hash); tx != nil { 1022 return newRPCPendingTransaction(tx) 1023 } 1024 // Transaction unknown, return as such 1025 return nil 1026 } 1027 1028 // GetRawTransactionByHash returns the bytes of the transaction for the given hash. 1029 func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) { 1030 var tx *types.Transaction 1031 1032 // Retrieve a finalized transaction, or a pooled otherwise 1033 if tx, _, _, _ = rawdb.ReadTransaction(s.b.ChainDb(), hash); tx == nil { 1034 if tx = s.b.GetPoolTransaction(hash); tx == nil { 1035 // Transaction not found anywhere, abort 1036 return nil, nil 1037 } 1038 } 1039 // Serialize to RLP and return 1040 return rlp.EncodeToBytes(tx) 1041 } 1042 1043 // GetTransactionReceipt returns the transaction receipt for the given transaction hash. 1044 func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) { 1045 tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash) 1046 if tx == nil { 1047 return nil, nil 1048 } 1049 receipts, err := s.b.GetReceipts(ctx, blockHash) 1050 if err != nil { 1051 return nil, err 1052 } 1053 if len(receipts) <= int(index) { 1054 return nil, nil 1055 } 1056 receipt := receipts[index] 1057 1058 var signer types.Signer = types.FrontierSigner{} 1059 if tx.Protected() { 1060 signer = types.NewEIP155Signer(tx.ChainId()) 1061 } 1062 from, _ := types.Sender(signer, tx) 1063 1064 fields := map[string]interface{}{ 1065 "blockHash": blockHash, 1066 "blockNumber": hexutil.Uint64(blockNumber), 1067 "transactionHash": hash, 1068 "transactionIndex": hexutil.Uint64(index), 1069 "from": from, 1070 "to": tx.To(), 1071 "gasUsed": hexutil.Uint64(receipt.GasUsed), 1072 "cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed), 1073 "contractAddress": nil, 1074 "logs": receipt.Logs, 1075 "logsBloom": receipt.Bloom, 1076 } 1077 1078 // Assign receipt status or post state. 1079 if len(receipt.PostState) > 0 { 1080 fields["root"] = hexutil.Bytes(receipt.PostState) 1081 } else { 1082 fields["status"] = hexutil.Uint(receipt.Status) 1083 } 1084 if receipt.Logs == nil { 1085 fields["logs"] = [][]*types.Log{} 1086 } 1087 // If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation 1088 if receipt.ContractAddress != (common.Address{}) { 1089 fields["contractAddress"] = receipt.ContractAddress 1090 } 1091 return fields, nil 1092 } 1093 1094 // sign is a helper function that signs a transaction with the private key of the given address. 1095 func (s *PublicTransactionPoolAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) { 1096 // Look up the wallet containing the requested signer 1097 account := accounts.Account{Address: addr} 1098 1099 wallet, err := s.b.AccountManager().Find(account) 1100 if err != nil { 1101 return nil, err 1102 } 1103 // Request the wallet to sign the transaction 1104 var chainID *big.Int 1105 if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) { 1106 chainID = config.ChainID 1107 } 1108 return wallet.SignTx(account, tx, chainID) 1109 } 1110 1111 // SendTxArgs represents the arguments to sumbit a new transaction into the transaction pool. 1112 type SendTxArgs struct { 1113 From common.Address `json:"from"` 1114 To *common.Address `json:"to"` 1115 Gas *hexutil.Uint64 `json:"gas"` 1116 GasPrice *hexutil.Big `json:"gasPrice"` 1117 Value *hexutil.Big `json:"value"` 1118 Nonce *hexutil.Uint64 `json:"nonce"` 1119 // We accept "data" and "input" for backwards-compatibility reasons. "input" is the 1120 // newer name and should be preferred by clients. 1121 Data *hexutil.Bytes `json:"data"` 1122 Input *hexutil.Bytes `json:"input"` 1123 } 1124 1125 // setDefaults is a helper function that fills in default values for unspecified tx fields. 1126 func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error { 1127 if args.Gas == nil { 1128 args.Gas = new(hexutil.Uint64) 1129 *(*uint64)(args.Gas) = 90000 1130 } 1131 if args.GasPrice == nil { 1132 price, err := b.SuggestPrice(ctx) 1133 if err != nil { 1134 return err 1135 } 1136 args.GasPrice = (*hexutil.Big)(price) 1137 } 1138 if args.Value == nil { 1139 args.Value = new(hexutil.Big) 1140 } 1141 if args.Nonce == nil { 1142 nonce, err := b.GetPoolNonce(ctx, args.From) 1143 if err != nil { 1144 return err 1145 } 1146 args.Nonce = (*hexutil.Uint64)(&nonce) 1147 } 1148 if args.Data != nil && args.Input != nil && !bytes.Equal(*args.Data, *args.Input) { 1149 return errors.New(`Both "data" and "input" are set and not equal. Please use "input" to pass transaction call data.`) 1150 } 1151 if args.To == nil { 1152 // Contract creation 1153 var input []byte 1154 if args.Data != nil { 1155 input = *args.Data 1156 } else if args.Input != nil { 1157 input = *args.Input 1158 } 1159 if len(input) == 0 { 1160 return errors.New(`contract creation without any data provided`) 1161 } 1162 } 1163 return nil 1164 } 1165 1166 func (args *SendTxArgs) toTransaction() *types.Transaction { 1167 var input []byte 1168 if args.Data != nil { 1169 input = *args.Data 1170 } else if args.Input != nil { 1171 input = *args.Input 1172 } 1173 if args.To == nil { 1174 return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input) 1175 } 1176 return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input) 1177 } 1178 1179 // submitTransaction is a helper function that submits tx to txPool and logs a message. 1180 func submitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) { 1181 if err := b.SendTx(ctx, tx); err != nil { 1182 return common.Hash{}, err 1183 } 1184 if tx.To() == nil { 1185 signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number()) 1186 from, err := types.Sender(signer, tx) 1187 if err != nil { 1188 return common.Hash{}, err 1189 } 1190 addr := crypto.CreateAddress(from, tx.Nonce()) 1191 log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex()) 1192 } else { 1193 log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To()) 1194 } 1195 return tx.Hash(), nil 1196 } 1197 1198 // SendTransaction creates a transaction for the given argument, sign it and submit it to the 1199 // transaction pool. 1200 func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args SendTxArgs) (common.Hash, error) { 1201 1202 // Look up the wallet containing the requested signer 1203 account := accounts.Account{Address: args.From} 1204 1205 wallet, err := s.b.AccountManager().Find(account) 1206 if err != nil { 1207 return common.Hash{}, err 1208 } 1209 1210 if args.Nonce == nil { 1211 // Hold the addresse's mutex around signing to prevent concurrent assignment of 1212 // the same nonce to multiple accounts. 1213 s.nonceLock.LockAddr(args.From) 1214 defer s.nonceLock.UnlockAddr(args.From) 1215 } 1216 1217 // Set some sanity defaults and terminate on failure 1218 if err := args.setDefaults(ctx, s.b); err != nil { 1219 return common.Hash{}, err 1220 } 1221 // Assemble the transaction and sign with the wallet 1222 tx := args.toTransaction() 1223 1224 var chainID *big.Int 1225 if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) { 1226 chainID = config.ChainID 1227 } 1228 signed, err := wallet.SignTx(account, tx, chainID) 1229 if err != nil { 1230 return common.Hash{}, err 1231 } 1232 return submitTransaction(ctx, s.b, signed) 1233 } 1234 1235 // SendRawTransaction will add the signed transaction to the transaction pool. 1236 // The sender is responsible for signing the transaction and using the correct nonce. 1237 func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) { 1238 tx := new(types.Transaction) 1239 if err := rlp.DecodeBytes(encodedTx, tx); err != nil { 1240 return common.Hash{}, err 1241 } 1242 return submitTransaction(ctx, s.b, tx) 1243 } 1244 1245 // Sign calculates an ECDSA signature for: 1246 // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message). 1247 // 1248 // Note, the produced signature conforms to the secp256k1 curve R, S and V values, 1249 // where the V value will be 27 or 28 for legacy reasons. 1250 // 1251 // The account associated with addr must be unlocked. 1252 // 1253 // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign 1254 func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) { 1255 // Look up the wallet containing the requested signer 1256 account := accounts.Account{Address: addr} 1257 1258 wallet, err := s.b.AccountManager().Find(account) 1259 if err != nil { 1260 return nil, err 1261 } 1262 // Sign the requested hash with the wallet 1263 signature, err := wallet.SignHash(account, signHash(data)) 1264 if err == nil { 1265 signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper 1266 } 1267 return signature, err 1268 } 1269 1270 // SignTransactionResult represents a RLP encoded signed transaction. 1271 type SignTransactionResult struct { 1272 Raw hexutil.Bytes `json:"raw"` 1273 Tx *types.Transaction `json:"tx"` 1274 } 1275 1276 // SignTransaction will sign the given transaction with the from account. 1277 // The node needs to have the private key of the account corresponding with 1278 // the given from address and it needs to be unlocked. 1279 func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) { 1280 if args.Gas == nil { 1281 return nil, fmt.Errorf("gas not specified") 1282 } 1283 if args.GasPrice == nil { 1284 return nil, fmt.Errorf("gasPrice not specified") 1285 } 1286 if args.Nonce == nil { 1287 return nil, fmt.Errorf("nonce not specified") 1288 } 1289 if err := args.setDefaults(ctx, s.b); err != nil { 1290 return nil, err 1291 } 1292 tx, err := s.sign(args.From, args.toTransaction()) 1293 if err != nil { 1294 return nil, err 1295 } 1296 data, err := rlp.EncodeToBytes(tx) 1297 if err != nil { 1298 return nil, err 1299 } 1300 return &SignTransactionResult{data, tx}, nil 1301 } 1302 1303 // PendingTransactions returns the transactions that are in the transaction pool 1304 // and have a from address that is one of the accounts this node manages. 1305 func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) { 1306 pending, err := s.b.GetPoolTransactions() 1307 if err != nil { 1308 return nil, err 1309 } 1310 accounts := make(map[common.Address]struct{}) 1311 for _, wallet := range s.b.AccountManager().Wallets() { 1312 for _, account := range wallet.Accounts() { 1313 accounts[account.Address] = struct{}{} 1314 } 1315 } 1316 transactions := make([]*RPCTransaction, 0, len(pending)) 1317 for _, tx := range pending { 1318 var signer types.Signer = types.HomesteadSigner{} 1319 if tx.Protected() { 1320 signer = types.NewEIP155Signer(tx.ChainId()) 1321 } 1322 from, _ := types.Sender(signer, tx) 1323 if _, exists := accounts[from]; exists { 1324 transactions = append(transactions, newRPCPendingTransaction(tx)) 1325 } 1326 } 1327 return transactions, nil 1328 } 1329 1330 // Resend accepts an existing transaction and a new gas price and limit. It will remove 1331 // the given transaction from the pool and reinsert it with the new gas price and limit. 1332 func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) { 1333 if sendArgs.Nonce == nil { 1334 return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec") 1335 } 1336 if err := sendArgs.setDefaults(ctx, s.b); err != nil { 1337 return common.Hash{}, err 1338 } 1339 matchTx := sendArgs.toTransaction() 1340 pending, err := s.b.GetPoolTransactions() 1341 if err != nil { 1342 return common.Hash{}, err 1343 } 1344 1345 for _, p := range pending { 1346 var signer types.Signer = types.HomesteadSigner{} 1347 if p.Protected() { 1348 signer = types.NewEIP155Signer(p.ChainId()) 1349 } 1350 wantSigHash := signer.Hash(matchTx) 1351 1352 if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash { 1353 // Match. Re-sign and send the transaction. 1354 if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 { 1355 sendArgs.GasPrice = gasPrice 1356 } 1357 if gasLimit != nil && *gasLimit != 0 { 1358 sendArgs.Gas = gasLimit 1359 } 1360 signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction()) 1361 if err != nil { 1362 return common.Hash{}, err 1363 } 1364 if err = s.b.SendTx(ctx, signedTx); err != nil { 1365 return common.Hash{}, err 1366 } 1367 return signedTx.Hash(), nil 1368 } 1369 } 1370 1371 return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash()) 1372 } 1373 1374 // PublicDebugAPI is the collection of Ethereum APIs exposed over the public 1375 // debugging endpoint. 1376 type PublicDebugAPI struct { 1377 b Backend 1378 } 1379 1380 // NewPublicDebugAPI creates a new API definition for the public debug methods 1381 // of the Ethereum service. 1382 func NewPublicDebugAPI(b Backend) *PublicDebugAPI { 1383 return &PublicDebugAPI{b: b} 1384 } 1385 1386 // GetBlockRlp retrieves the RLP encoded for of a single block. 1387 func (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) { 1388 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1389 if block == nil { 1390 return "", fmt.Errorf("block #%d not found", number) 1391 } 1392 encoded, err := rlp.EncodeToBytes(block) 1393 if err != nil { 1394 return "", err 1395 } 1396 return fmt.Sprintf("%x", encoded), nil 1397 } 1398 1399 // PrintBlock retrieves a block and returns its pretty printed form. 1400 func (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) { 1401 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1402 if block == nil { 1403 return "", fmt.Errorf("block #%d not found", number) 1404 } 1405 return spew.Sdump(block), nil 1406 } 1407 1408 // SeedHash retrieves the seed hash of a block. 1409 func (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) { 1410 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1411 if block == nil { 1412 return "", fmt.Errorf("block #%d not found", number) 1413 } 1414 return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil 1415 } 1416 1417 // PrivateDebugAPI is the collection of Ethereum APIs exposed over the private 1418 // debugging endpoint. 1419 type PrivateDebugAPI struct { 1420 b Backend 1421 } 1422 1423 // NewPrivateDebugAPI creates a new API definition for the private debug methods 1424 // of the Ethereum service. 1425 func NewPrivateDebugAPI(b Backend) *PrivateDebugAPI { 1426 return &PrivateDebugAPI{b: b} 1427 } 1428 1429 // ChaindbProperty returns leveldb properties of the chain database. 1430 func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) { 1431 ldb, ok := api.b.ChainDb().(interface { 1432 LDB() *leveldb.DB 1433 }) 1434 if !ok { 1435 return "", fmt.Errorf("chaindbProperty does not work for memory databases") 1436 } 1437 if property == "" { 1438 property = "leveldb.stats" 1439 } else if !strings.HasPrefix(property, "leveldb.") { 1440 property = "leveldb." + property 1441 } 1442 return ldb.LDB().GetProperty(property) 1443 } 1444 1445 func (api *PrivateDebugAPI) ChaindbCompact() error { 1446 ldb, ok := api.b.ChainDb().(interface { 1447 LDB() *leveldb.DB 1448 }) 1449 if !ok { 1450 return fmt.Errorf("chaindbCompact does not work for memory databases") 1451 } 1452 for b := byte(0); b < 255; b++ { 1453 log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1)) 1454 err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}}) 1455 if err != nil { 1456 log.Error("Database compaction failed", "err", err) 1457 return err 1458 } 1459 } 1460 return nil 1461 } 1462 1463 // SetHead rewinds the head of the blockchain to a previous block. 1464 func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) { 1465 api.b.SetHead(uint64(number)) 1466 } 1467 1468 // PublicNetAPI offers network related RPC methods 1469 type PublicNetAPI struct { 1470 net *p2p.Server 1471 networkVersion uint64 1472 } 1473 1474 // NewPublicNetAPI creates a new net API instance. 1475 func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI { 1476 return &PublicNetAPI{net, networkVersion} 1477 } 1478 1479 // Listening returns an indication if the node is listening for network connections. 1480 func (s *PublicNetAPI) Listening() bool { 1481 return true // always listening 1482 } 1483 1484 // PeerCount returns the number of connected peers 1485 func (s *PublicNetAPI) PeerCount() hexutil.Uint { 1486 return hexutil.Uint(s.net.PeerCount()) 1487 } 1488 1489 // Version returns the current ethereum protocol version. 1490 func (s *PublicNetAPI) Version() string { 1491 return fmt.Sprintf("%d", s.networkVersion) 1492 }