github.com/jincm/wesharechain@v0.0.0-20210122032815-1537409ce26a/chain/internal/ethapi/api.go (about) 1 // Copyright 2015 The go-ethereum Authors 2 // This file is part of the go-ethereum library. 3 // 4 // The go-ethereum library is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU Lesser General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // The go-ethereum library is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU Lesser General Public License for more details. 13 // 14 // You should have received a copy of the GNU Lesser General Public License 15 // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. 16 17 package ethapi 18 19 import ( 20 "bytes" 21 "context" 22 "errors" 23 "fmt" 24 "math/big" 25 "strings" 26 "time" 27 28 "github.com/davecgh/go-spew/spew" 29 "github.com/ethereum/go-ethereum/accounts" 30 "github.com/ethereum/go-ethereum/accounts/keystore" 31 "github.com/ethereum/go-ethereum/common" 32 "github.com/ethereum/go-ethereum/common/hexutil" 33 "github.com/ethereum/go-ethereum/common/math" 34 "github.com/ethereum/go-ethereum/consensus/clique" 35 "github.com/ethereum/go-ethereum/consensus/ethash" 36 "github.com/ethereum/go-ethereum/core" 37 "github.com/ethereum/go-ethereum/core/rawdb" 38 "github.com/ethereum/go-ethereum/core/types" 39 "github.com/ethereum/go-ethereum/core/vm" 40 "github.com/ethereum/go-ethereum/crypto" 41 "github.com/ethereum/go-ethereum/log" 42 "github.com/ethereum/go-ethereum/p2p" 43 "github.com/ethereum/go-ethereum/params" 44 "github.com/ethereum/go-ethereum/rlp" 45 "github.com/ethereum/go-ethereum/rpc" 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 if err != nil { 333 log.Warn("Failed account unlock attempt", "address", addr, "err", err) 334 } 335 return err == nil, err 336 } 337 338 // LockAccount will lock the account associated with the given address when it's unlocked. 339 func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool { 340 return fetchKeystore(s.am).Lock(addr) == nil 341 } 342 343 // signTransaction sets defaults and signs the given transaction 344 // NOTE: the caller needs to ensure that the nonceLock is held, if applicable, 345 // and release it after the transaction has been submitted to the tx pool 346 func (s *PrivateAccountAPI) signTransaction(ctx context.Context, args *SendTxArgs, passwd string) (*types.Transaction, error) { 347 // Look up the wallet containing the requested signer 348 account := accounts.Account{Address: args.From} 349 wallet, err := s.am.Find(account) 350 if err != nil { 351 return nil, err 352 } 353 // Set some sanity defaults and terminate on failure 354 if err := args.setDefaults(ctx, s.b); err != nil { 355 return nil, err 356 } 357 // Assemble the transaction and sign with the wallet 358 tx := args.toTransaction() 359 360 return wallet.SignTxWithPassphrase(account, passwd, tx, s.b.ChainConfig().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 log.Warn("Failed transaction send attempt", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err) 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 log.Warn("Failed transaction sign attempt", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err) 400 return nil, err 401 } 402 data, err := rlp.EncodeToBytes(signed) 403 if err != nil { 404 return nil, err 405 } 406 return &SignTransactionResult{data, signed}, nil 407 } 408 409 // Sign calculates an Ethereum ECDSA signature for: 410 // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message)) 411 // 412 // Note, the produced signature conforms to the secp256k1 curve R, S and V values, 413 // where the V value will be 27 or 28 for legacy reasons. 414 // 415 // The key used to calculate the signature is decrypted with the given password. 416 // 417 // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign 418 func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) { 419 // Look up the wallet containing the requested signer 420 account := accounts.Account{Address: addr} 421 422 wallet, err := s.b.AccountManager().Find(account) 423 if err != nil { 424 return nil, err 425 } 426 // Assemble sign the data with the wallet 427 signature, err := wallet.SignTextWithPassphrase(account, passwd, data) 428 if err != nil { 429 log.Warn("Failed data sign attempt", "address", addr, "err", err) 430 return nil, err 431 } 432 signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper 433 return signature, nil 434 } 435 436 // EcRecover returns the address for the account that was used to create the signature. 437 // Note, this function is compatible with eth_sign and personal_sign. As such it recovers 438 // the address of: 439 // hash = keccak256("\x19Ethereum Signed Message:\n"${message length}${message}) 440 // addr = ecrecover(hash, signature) 441 // 442 // Note, the signature must conform to the secp256k1 curve R, S and V values, where 443 // the V value must be 27 or 28 for legacy reasons. 444 // 445 // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover 446 func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) { 447 if len(sig) != 65 { 448 return common.Address{}, fmt.Errorf("signature must be 65 bytes long") 449 } 450 if sig[64] != 27 && sig[64] != 28 { 451 return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)") 452 } 453 sig[64] -= 27 // Transform yellow paper V from 27/28 to 0/1 454 455 rpk, err := crypto.SigToPub(accounts.TextHash(data), sig) 456 if err != nil { 457 return common.Address{}, err 458 } 459 return crypto.PubkeyToAddress(*rpk), nil 460 } 461 462 // SignAndSendTransaction was renamed to SendTransaction. This method is deprecated 463 // and will be removed in the future. It primary goal is to give clients time to update. 464 func (s *PrivateAccountAPI) SignAndSendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) { 465 return s.SendTransaction(ctx, args, passwd) 466 } 467 468 // PublicBlockChainAPI provides an API to access the Ethereum blockchain. 469 // It offers only methods that operate on public data that is freely available to anyone. 470 type PublicBlockChainAPI struct { 471 b Backend 472 } 473 474 // NewPublicBlockChainAPI creates a new Ethereum blockchain API. 475 func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI { 476 return &PublicBlockChainAPI{b} 477 } 478 479 // BlockNumber returns the block number of the chain head. 480 func (s *PublicBlockChainAPI) BlockNumber() hexutil.Uint64 { 481 header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available 482 return hexutil.Uint64(header.Number.Uint64()) 483 } 484 485 // GetBalance returns the amount of wei for the given address in the state of the 486 // given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta 487 // block numbers are also allowed. 488 func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Big, error) { 489 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 490 if state == nil || err != nil { 491 return nil, err 492 } 493 return (*hexutil.Big)(state.GetBalance(address)), state.Error() 494 } 495 496 // Result structs for GetProof 497 type AccountResult struct { 498 Address common.Address `json:"address"` 499 AccountProof []string `json:"accountProof"` 500 Balance *hexutil.Big `json:"balance"` 501 CodeHash common.Hash `json:"codeHash"` 502 Nonce hexutil.Uint64 `json:"nonce"` 503 StorageHash common.Hash `json:"storageHash"` 504 StorageProof []StorageResult `json:"storageProof"` 505 } 506 type StorageResult struct { 507 Key string `json:"key"` 508 Value *hexutil.Big `json:"value"` 509 Proof []string `json:"proof"` 510 } 511 512 // GetProof returns the Merkle-proof for a given account and optionally some storage keys. 513 func (s *PublicBlockChainAPI) GetProof(ctx context.Context, address common.Address, storageKeys []string, blockNr rpc.BlockNumber) (*AccountResult, error) { 514 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 515 if state == nil || err != nil { 516 return nil, err 517 } 518 519 storageTrie := state.StorageTrie(address) 520 storageHash := types.EmptyRootHash 521 codeHash := state.GetCodeHash(address) 522 storageProof := make([]StorageResult, len(storageKeys)) 523 524 // if we have a storageTrie, (which means the account exists), we can update the storagehash 525 if storageTrie != nil { 526 storageHash = storageTrie.Hash() 527 } else { 528 // no storageTrie means the account does not exist, so the codeHash is the hash of an empty bytearray. 529 codeHash = crypto.Keccak256Hash(nil) 530 } 531 532 // create the proof for the storageKeys 533 for i, key := range storageKeys { 534 if storageTrie != nil { 535 proof, storageError := state.GetStorageProof(address, common.HexToHash(key)) 536 if storageError != nil { 537 return nil, storageError 538 } 539 storageProof[i] = StorageResult{key, (*hexutil.Big)(state.GetState(address, common.HexToHash(key)).Big()), common.ToHexArray(proof)} 540 } else { 541 storageProof[i] = StorageResult{key, &hexutil.Big{}, []string{}} 542 } 543 } 544 545 // create the accountProof 546 accountProof, proofErr := state.GetProof(address) 547 if proofErr != nil { 548 return nil, proofErr 549 } 550 551 return &AccountResult{ 552 Address: address, 553 AccountProof: common.ToHexArray(accountProof), 554 Balance: (*hexutil.Big)(state.GetBalance(address)), 555 CodeHash: codeHash, 556 Nonce: hexutil.Uint64(state.GetNonce(address)), 557 StorageHash: storageHash, 558 StorageProof: storageProof, 559 }, state.Error() 560 } 561 562 // GetBlockByNumber returns the requested block. When blockNr is -1 the chain head is returned. When fullTx is true all 563 // transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 564 func (s *PublicBlockChainAPI) GetBlockByNumber(ctx context.Context, blockNr rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) { 565 block, err := s.b.BlockByNumber(ctx, blockNr) 566 if block != nil { 567 response, err := s.rpcOutputBlock(block, true, fullTx) 568 if err == nil && blockNr == rpc.PendingBlockNumber { 569 // Pending blocks need to nil out a few fields 570 for _, field := range []string{"hash", "nonce", "miner"} { 571 response[field] = nil 572 } 573 } 574 return response, err 575 } 576 return nil, err 577 } 578 579 // GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full 580 // detail, otherwise only the transaction hash is returned. 581 func (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, blockHash common.Hash, fullTx bool) (map[string]interface{}, error) { 582 block, err := s.b.GetBlock(ctx, blockHash) 583 if block != nil { 584 return s.rpcOutputBlock(block, true, fullTx) 585 } 586 return nil, err 587 } 588 589 // GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true 590 // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 591 func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) { 592 block, err := s.b.BlockByNumber(ctx, blockNr) 593 if block != nil { 594 uncles := block.Uncles() 595 if index >= hexutil.Uint(len(uncles)) { 596 log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index) 597 return nil, nil 598 } 599 block = types.NewBlockWithHeader(uncles[index]) 600 return s.rpcOutputBlock(block, false, false) 601 } 602 return nil, err 603 } 604 605 // GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true 606 // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 607 func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) { 608 block, err := s.b.GetBlock(ctx, blockHash) 609 if block != nil { 610 uncles := block.Uncles() 611 if index >= hexutil.Uint(len(uncles)) { 612 log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index) 613 return nil, nil 614 } 615 block = types.NewBlockWithHeader(uncles[index]) 616 return s.rpcOutputBlock(block, false, false) 617 } 618 return nil, err 619 } 620 621 // GetUncleCountByBlockNumber returns number of uncles in the block for the given block number 622 func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint { 623 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 624 n := hexutil.Uint(len(block.Uncles())) 625 return &n 626 } 627 return nil 628 } 629 630 // GetUncleCountByBlockHash returns number of uncles in the block for the given block hash 631 func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint { 632 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 633 n := hexutil.Uint(len(block.Uncles())) 634 return &n 635 } 636 return nil 637 } 638 639 // GetCode returns the code stored at the given address in the state for the given block number. 640 func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (hexutil.Bytes, error) { 641 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 642 if state == nil || err != nil { 643 return nil, err 644 } 645 code := state.GetCode(address) 646 return code, state.Error() 647 } 648 649 // GetStorageAt returns the storage from the state at the given address, key and 650 // block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block 651 // numbers are also allowed. 652 func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNr rpc.BlockNumber) (hexutil.Bytes, error) { 653 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 654 if state == nil || err != nil { 655 return nil, err 656 } 657 res := state.GetState(address, common.HexToHash(key)) 658 return res[:], state.Error() 659 } 660 661 // CallArgs represents the arguments for a call. 662 type CallArgs struct { 663 From *common.Address `json:"from"` 664 To *common.Address `json:"to"` 665 Gas *hexutil.Uint64 `json:"gas"` 666 GasPrice *hexutil.Big `json:"gasPrice"` 667 Value *hexutil.Big `json:"value"` 668 Data *hexutil.Bytes `json:"data"` 669 } 670 671 func DoCall(ctx context.Context, b Backend, args CallArgs, blockNr rpc.BlockNumber, vmCfg vm.Config, timeout time.Duration) ([]byte, uint64, bool, error) { 672 defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now()) 673 674 state, header, err := b.StateAndHeaderByNumber(ctx, blockNr) 675 if state == nil || err != nil { 676 return nil, 0, false, err 677 } 678 // Set sender address or use a default if none specified 679 var addr common.Address 680 if args.From == nil { 681 if wallets := b.AccountManager().Wallets(); len(wallets) > 0 { 682 if accounts := wallets[0].Accounts(); len(accounts) > 0 { 683 addr = accounts[0].Address 684 } 685 } 686 } else { 687 addr = *args.From 688 } 689 // Set default gas & gas price if none were set 690 gas := uint64(math.MaxUint64 / 2) 691 if args.Gas != nil { 692 gas = uint64(*args.Gas) 693 } 694 gasPrice := new(big.Int).SetUint64(defaultGasPrice) 695 if args.GasPrice != nil { 696 gasPrice = args.GasPrice.ToInt() 697 } 698 699 value := new(big.Int) 700 if args.Value != nil { 701 value = args.Value.ToInt() 702 } 703 704 var data []byte 705 if args.Data != nil { 706 data = []byte(*args.Data) 707 } 708 709 // Create new call message 710 msg := types.NewMessage(addr, args.To, 0, value, gas, gasPrice, data, false) 711 712 // Setup context so it may be cancelled the call has completed 713 // or, in case of unmetered gas, setup a context with a timeout. 714 var cancel context.CancelFunc 715 if timeout > 0 { 716 ctx, cancel = context.WithTimeout(ctx, timeout) 717 } else { 718 ctx, cancel = context.WithCancel(ctx) 719 } 720 // Make sure the context is cancelled when the call has completed 721 // this makes sure resources are cleaned up. 722 defer cancel() 723 724 // Get a new instance of the EVM. 725 evm, vmError, err := b.GetEVM(ctx, msg, state, header) 726 if err != nil { 727 return nil, 0, false, err 728 } 729 // Wait for the context to be done and cancel the evm. Even if the 730 // EVM has finished, cancelling may be done (repeatedly) 731 go func() { 732 <-ctx.Done() 733 evm.Cancel() 734 }() 735 736 // Setup the gas pool (also for unmetered requests) 737 // and apply the message. 738 gp := new(core.GasPool).AddGas(math.MaxUint64) 739 res, gas, failed, err := core.ApplyMessage(evm, msg, gp) 740 if err := vmError(); err != nil { 741 return nil, 0, false, err 742 } 743 return res, gas, failed, err 744 } 745 746 // Call executes the given transaction on the state for the given block number. 747 // It doesn't make and changes in the state/blockchain and is useful to execute and retrieve values. 748 func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Bytes, error) { 749 result, _, _, err := DoCall(ctx, s.b, args, blockNr, vm.Config{}, 5*time.Second) 750 return (hexutil.Bytes)(result), err 751 } 752 753 func DoEstimateGas(ctx context.Context, b Backend, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Uint64, error) { 754 // Binary search the gas requirement, as it may be higher than the amount used 755 var ( 756 lo uint64 = params.TxGas - 1 757 hi uint64 758 cap uint64 759 ) 760 if args.Gas != nil && uint64(*args.Gas) >= params.TxGas { 761 hi = uint64(*args.Gas) 762 } else { 763 // Retrieve the block to act as the gas ceiling 764 block, err := b.BlockByNumber(ctx, blockNr) 765 if err != nil { 766 return 0, err 767 } 768 hi = block.GasLimit() 769 } 770 cap = hi 771 772 // Create a helper to check if a gas allowance results in an executable transaction 773 executable := func(gas uint64) bool { 774 args.Gas = (*hexutil.Uint64)(&gas) 775 776 _, _, failed, err := DoCall(ctx, b, args, rpc.PendingBlockNumber, vm.Config{}, 0) 777 if err != nil || failed { 778 return false 779 } 780 return true 781 } 782 // Execute the binary search and hone in on an executable gas limit 783 for lo+1 < hi { 784 mid := (hi + lo) / 2 785 if !executable(mid) { 786 lo = mid 787 } else { 788 hi = mid 789 } 790 } 791 // Reject the transaction as invalid if it still fails at the highest allowance 792 if hi == cap { 793 if !executable(hi) { 794 return 0, fmt.Errorf("gas required exceeds allowance or always failing transaction") 795 } 796 } 797 return hexutil.Uint64(hi), nil 798 } 799 800 // EstimateGas returns an estimate of the amount of gas needed to execute the 801 // given transaction against the current pending block. 802 func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (hexutil.Uint64, error) { 803 return DoEstimateGas(ctx, s.b, args, rpc.PendingBlockNumber) 804 } 805 806 // ExecutionResult groups all structured logs emitted by the EVM 807 // while replaying a transaction in debug mode as well as transaction 808 // execution status, the amount of gas used and the return value 809 type ExecutionResult struct { 810 Gas uint64 `json:"gas"` 811 Failed bool `json:"failed"` 812 ReturnValue string `json:"returnValue"` 813 StructLogs []StructLogRes `json:"structLogs"` 814 } 815 816 // StructLogRes stores a structured log emitted by the EVM while replaying a 817 // transaction in debug mode 818 type StructLogRes struct { 819 Pc uint64 `json:"pc"` 820 Op string `json:"op"` 821 Gas uint64 `json:"gas"` 822 GasCost uint64 `json:"gasCost"` 823 Depth int `json:"depth"` 824 Error error `json:"error,omitempty"` 825 Stack *[]string `json:"stack,omitempty"` 826 Memory *[]string `json:"memory,omitempty"` 827 Storage *map[string]string `json:"storage,omitempty"` 828 } 829 830 // FormatLogs formats EVM returned structured logs for json output 831 func FormatLogs(logs []vm.StructLog) []StructLogRes { 832 formatted := make([]StructLogRes, len(logs)) 833 for index, trace := range logs { 834 formatted[index] = StructLogRes{ 835 Pc: trace.Pc, 836 Op: trace.Op.String(), 837 Gas: trace.Gas, 838 GasCost: trace.GasCost, 839 Depth: trace.Depth, 840 Error: trace.Err, 841 } 842 if trace.Stack != nil { 843 stack := make([]string, len(trace.Stack)) 844 for i, stackValue := range trace.Stack { 845 stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32)) 846 } 847 formatted[index].Stack = &stack 848 } 849 if trace.Memory != nil { 850 memory := make([]string, 0, (len(trace.Memory)+31)/32) 851 for i := 0; i+32 <= len(trace.Memory); i += 32 { 852 memory = append(memory, fmt.Sprintf("%x", trace.Memory[i:i+32])) 853 } 854 formatted[index].Memory = &memory 855 } 856 if trace.Storage != nil { 857 storage := make(map[string]string) 858 for i, storageValue := range trace.Storage { 859 storage[fmt.Sprintf("%x", i)] = fmt.Sprintf("%x", storageValue) 860 } 861 formatted[index].Storage = &storage 862 } 863 } 864 return formatted 865 } 866 867 // RPCMarshalBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are 868 // returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain 869 // transaction hashes. 870 func RPCMarshalBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) { 871 head := b.Header() // copies the header once 872 fields := map[string]interface{}{ 873 "number": (*hexutil.Big)(head.Number), 874 "hash": b.Hash(), 875 "parentHash": head.ParentHash, 876 "nonce": head.Nonce, 877 "mixHash": head.MixDigest, 878 "sha3Uncles": head.UncleHash, 879 "logsBloom": head.Bloom, 880 "stateRoot": head.Root, 881 "miner": head.Coinbase, 882 "difficulty": (*hexutil.Big)(head.Difficulty), 883 "extraData": hexutil.Bytes(head.Extra), 884 "size": hexutil.Uint64(b.Size()), 885 "gasLimit": hexutil.Uint64(head.GasLimit), 886 "gasUsed": hexutil.Uint64(head.GasUsed), 887 "timestamp": (*hexutil.Big)(head.Time), 888 "transactionsRoot": head.TxHash, 889 "receiptsRoot": head.ReceiptHash, 890 } 891 892 if inclTx { 893 formatTx := func(tx *types.Transaction) (interface{}, error) { 894 return tx.Hash(), nil 895 } 896 if fullTx { 897 formatTx = func(tx *types.Transaction) (interface{}, error) { 898 return newRPCTransactionFromBlockHash(b, tx.Hash()), nil 899 } 900 } 901 txs := b.Transactions() 902 transactions := make([]interface{}, len(txs)) 903 var err error 904 for i, tx := range txs { 905 if transactions[i], err = formatTx(tx); err != nil { 906 return nil, err 907 } 908 } 909 fields["transactions"] = transactions 910 } 911 912 uncles := b.Uncles() 913 uncleHashes := make([]common.Hash, len(uncles)) 914 for i, uncle := range uncles { 915 uncleHashes[i] = uncle.Hash() 916 } 917 fields["uncles"] = uncleHashes 918 919 return fields, nil 920 } 921 922 // rpcOutputBlock uses the generalized output filler, then adds the total difficulty field, which requires 923 // a `PublicBlockchainAPI`. 924 func (s *PublicBlockChainAPI) rpcOutputBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) { 925 fields, err := RPCMarshalBlock(b, inclTx, fullTx) 926 if err != nil { 927 return nil, err 928 } 929 fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(b.Hash())) 930 return fields, err 931 } 932 933 // RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction 934 type RPCTransaction struct { 935 BlockHash common.Hash `json:"blockHash"` 936 BlockNumber *hexutil.Big `json:"blockNumber"` 937 From common.Address `json:"from"` 938 Gas hexutil.Uint64 `json:"gas"` 939 GasPrice *hexutil.Big `json:"gasPrice"` 940 Hash common.Hash `json:"hash"` 941 Input hexutil.Bytes `json:"input"` 942 Nonce hexutil.Uint64 `json:"nonce"` 943 To *common.Address `json:"to"` 944 TransactionIndex hexutil.Uint `json:"transactionIndex"` 945 Value *hexutil.Big `json:"value"` 946 V *hexutil.Big `json:"v"` 947 R *hexutil.Big `json:"r"` 948 S *hexutil.Big `json:"s"` 949 } 950 951 // newRPCTransaction returns a transaction that will serialize to the RPC 952 // representation, with the given location metadata set (if available). 953 func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64) *RPCTransaction { 954 var signer types.Signer = types.FrontierSigner{} 955 if tx.Protected() { 956 signer = types.NewEIP155Signer(tx.ChainId()) 957 } 958 from, _ := types.Sender(signer, tx) 959 v, r, s := tx.RawSignatureValues() 960 961 result := &RPCTransaction{ 962 From: from, 963 Gas: hexutil.Uint64(tx.Gas()), 964 GasPrice: (*hexutil.Big)(tx.GasPrice()), 965 Hash: tx.Hash(), 966 Input: hexutil.Bytes(tx.Data()), 967 Nonce: hexutil.Uint64(tx.Nonce()), 968 To: tx.To(), 969 Value: (*hexutil.Big)(tx.Value()), 970 V: (*hexutil.Big)(v), 971 R: (*hexutil.Big)(r), 972 S: (*hexutil.Big)(s), 973 } 974 if blockHash != (common.Hash{}) { 975 result.BlockHash = blockHash 976 result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber)) 977 result.TransactionIndex = hexutil.Uint(index) 978 } 979 return result 980 } 981 982 // newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation 983 func newRPCPendingTransaction(tx *types.Transaction) *RPCTransaction { 984 return newRPCTransaction(tx, common.Hash{}, 0, 0) 985 } 986 987 // newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation. 988 func newRPCTransactionFromBlockIndex(b *types.Block, index uint64) *RPCTransaction { 989 txs := b.Transactions() 990 if index >= uint64(len(txs)) { 991 return nil 992 } 993 return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index) 994 } 995 996 // newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index. 997 func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes { 998 txs := b.Transactions() 999 if index >= uint64(len(txs)) { 1000 return nil 1001 } 1002 blob, _ := rlp.EncodeToBytes(txs[index]) 1003 return blob 1004 } 1005 1006 // newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation. 1007 func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction { 1008 for idx, tx := range b.Transactions() { 1009 if tx.Hash() == hash { 1010 return newRPCTransactionFromBlockIndex(b, uint64(idx)) 1011 } 1012 } 1013 return nil 1014 } 1015 1016 // PublicTransactionPoolAPI exposes methods for the RPC interface 1017 type PublicTransactionPoolAPI struct { 1018 b Backend 1019 nonceLock *AddrLocker 1020 } 1021 1022 // NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool. 1023 func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI { 1024 return &PublicTransactionPoolAPI{b, nonceLock} 1025 } 1026 1027 // GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number. 1028 func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint { 1029 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 1030 n := hexutil.Uint(len(block.Transactions())) 1031 return &n 1032 } 1033 return nil 1034 } 1035 1036 // GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash. 1037 func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint { 1038 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 1039 n := hexutil.Uint(len(block.Transactions())) 1040 return &n 1041 } 1042 return nil 1043 } 1044 1045 // GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index. 1046 func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction { 1047 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 1048 return newRPCTransactionFromBlockIndex(block, uint64(index)) 1049 } 1050 return nil 1051 } 1052 1053 // GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index. 1054 func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction { 1055 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 1056 return newRPCTransactionFromBlockIndex(block, uint64(index)) 1057 } 1058 return nil 1059 } 1060 1061 // GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index. 1062 func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes { 1063 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 1064 return newRPCRawTransactionFromBlockIndex(block, uint64(index)) 1065 } 1066 return nil 1067 } 1068 1069 // GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index. 1070 func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes { 1071 if block, _ := s.b.GetBlock(ctx, blockHash); block != nil { 1072 return newRPCRawTransactionFromBlockIndex(block, uint64(index)) 1073 } 1074 return nil 1075 } 1076 1077 // GetTransactionCount returns the number of transactions the given address has sent for the given block number 1078 func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) { 1079 // Ask transaction pool for the nonce which includes pending transactions 1080 if blockNr == rpc.PendingBlockNumber { 1081 nonce, err := s.b.GetPoolNonce(ctx, address) 1082 if err != nil { 1083 return nil, err 1084 } 1085 return (*hexutil.Uint64)(&nonce), nil 1086 } 1087 // Resolve block number and use its state to ask for the nonce 1088 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 1089 if state == nil || err != nil { 1090 return nil, err 1091 } 1092 nonce := state.GetNonce(address) 1093 return (*hexutil.Uint64)(&nonce), state.Error() 1094 } 1095 1096 // GetTransactionByHash returns the transaction for the given hash 1097 func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) *RPCTransaction { 1098 // Try to return an already finalized transaction 1099 if tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash); tx != nil { 1100 return newRPCTransaction(tx, blockHash, blockNumber, index) 1101 } 1102 // No finalized transaction, try to retrieve it from the pool 1103 if tx := s.b.GetPoolTransaction(hash); tx != nil { 1104 return newRPCPendingTransaction(tx) 1105 } 1106 // Transaction unknown, return as such 1107 return nil 1108 } 1109 1110 // GetRawTransactionByHash returns the bytes of the transaction for the given hash. 1111 func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) { 1112 var tx *types.Transaction 1113 1114 // Retrieve a finalized transaction, or a pooled otherwise 1115 if tx, _, _, _ = rawdb.ReadTransaction(s.b.ChainDb(), hash); tx == nil { 1116 if tx = s.b.GetPoolTransaction(hash); tx == nil { 1117 // Transaction not found anywhere, abort 1118 return nil, nil 1119 } 1120 } 1121 // Serialize to RLP and return 1122 return rlp.EncodeToBytes(tx) 1123 } 1124 1125 // GetTransactionReceipt returns the transaction receipt for the given transaction hash. 1126 func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) { 1127 tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash) 1128 if tx == nil { 1129 return nil, nil 1130 } 1131 receipts, err := s.b.GetReceipts(ctx, blockHash) 1132 if err != nil { 1133 return nil, err 1134 } 1135 if len(receipts) <= int(index) { 1136 return nil, nil 1137 } 1138 receipt := receipts[index] 1139 1140 var signer types.Signer = types.FrontierSigner{} 1141 if tx.Protected() { 1142 signer = types.NewEIP155Signer(tx.ChainId()) 1143 } 1144 from, _ := types.Sender(signer, tx) 1145 1146 fields := map[string]interface{}{ 1147 "blockHash": blockHash, 1148 "blockNumber": hexutil.Uint64(blockNumber), 1149 "transactionHash": hash, 1150 "transactionIndex": hexutil.Uint64(index), 1151 "from": from, 1152 "to": tx.To(), 1153 "gasUsed": hexutil.Uint64(receipt.GasUsed), 1154 "cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed), 1155 "contractAddress": nil, 1156 "logs": receipt.Logs, 1157 "logsBloom": receipt.Bloom, 1158 } 1159 1160 // Assign receipt status or post state. 1161 if len(receipt.PostState) > 0 { 1162 fields["root"] = hexutil.Bytes(receipt.PostState) 1163 } else { 1164 fields["status"] = hexutil.Uint(receipt.Status) 1165 } 1166 if receipt.Logs == nil { 1167 fields["logs"] = [][]*types.Log{} 1168 } 1169 // If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation 1170 if receipt.ContractAddress != (common.Address{}) { 1171 fields["contractAddress"] = receipt.ContractAddress 1172 } 1173 return fields, nil 1174 } 1175 1176 // sign is a helper function that signs a transaction with the private key of the given address. 1177 func (s *PublicTransactionPoolAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) { 1178 // Look up the wallet containing the requested signer 1179 account := accounts.Account{Address: addr} 1180 1181 wallet, err := s.b.AccountManager().Find(account) 1182 if err != nil { 1183 return nil, err 1184 } 1185 // Request the wallet to sign the transaction 1186 return wallet.SignTx(account, tx, s.b.ChainConfig().ChainID) 1187 } 1188 1189 // SendTxArgs represents the arguments to sumbit a new transaction into the transaction pool. 1190 type SendTxArgs struct { 1191 From common.Address `json:"from"` 1192 To *common.Address `json:"to"` 1193 Gas *hexutil.Uint64 `json:"gas"` 1194 GasPrice *hexutil.Big `json:"gasPrice"` 1195 Value *hexutil.Big `json:"value"` 1196 Nonce *hexutil.Uint64 `json:"nonce"` 1197 // We accept "data" and "input" for backwards-compatibility reasons. "input" is the 1198 // newer name and should be preferred by clients. 1199 Data *hexutil.Bytes `json:"data"` 1200 Input *hexutil.Bytes `json:"input"` 1201 } 1202 1203 // setDefaults is a helper function that fills in default values for unspecified tx fields. 1204 func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error { 1205 if args.Gas == nil { 1206 args.Gas = new(hexutil.Uint64) 1207 *(*uint64)(args.Gas) = 90000 1208 } 1209 if args.GasPrice == nil { 1210 price, err := b.SuggestPrice(ctx) 1211 if err != nil { 1212 return err 1213 } 1214 args.GasPrice = (*hexutil.Big)(price) 1215 } 1216 if args.Value == nil { 1217 args.Value = new(hexutil.Big) 1218 } 1219 if args.Nonce == nil { 1220 nonce, err := b.GetPoolNonce(ctx, args.From) 1221 if err != nil { 1222 return err 1223 } 1224 args.Nonce = (*hexutil.Uint64)(&nonce) 1225 } 1226 if args.Data != nil && args.Input != nil && !bytes.Equal(*args.Data, *args.Input) { 1227 return errors.New(`Both "data" and "input" are set and not equal. Please use "input" to pass transaction call data.`) 1228 } 1229 if args.To == nil { 1230 // Contract creation 1231 var input []byte 1232 if args.Data != nil { 1233 input = *args.Data 1234 } else if args.Input != nil { 1235 input = *args.Input 1236 } 1237 if len(input) == 0 { 1238 return errors.New(`contract creation without any data provided`) 1239 } 1240 } 1241 return nil 1242 } 1243 1244 func (args *SendTxArgs) toTransaction() *types.Transaction { 1245 var input []byte 1246 if args.Data != nil { 1247 input = *args.Data 1248 } else if args.Input != nil { 1249 input = *args.Input 1250 } 1251 if args.To == nil { 1252 return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input) 1253 } 1254 return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input) 1255 } 1256 1257 // SubmitTransaction is a helper function that submits tx to txPool and logs a message. 1258 func SubmitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) { 1259 if err := b.SendTx(ctx, tx); err != nil { 1260 return common.Hash{}, err 1261 } 1262 if tx.To() == nil { 1263 signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number()) 1264 from, err := types.Sender(signer, tx) 1265 if err != nil { 1266 return common.Hash{}, err 1267 } 1268 addr := crypto.CreateAddress(from, tx.Nonce()) 1269 log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex()) 1270 } else { 1271 log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To()) 1272 } 1273 return tx.Hash(), nil 1274 } 1275 1276 // SendTransaction creates a transaction for the given argument, sign it and submit it to the 1277 // transaction pool. 1278 func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args SendTxArgs) (common.Hash, error) { 1279 1280 // Look up the wallet containing the requested signer 1281 account := accounts.Account{Address: args.From} 1282 1283 wallet, err := s.b.AccountManager().Find(account) 1284 if err != nil { 1285 return common.Hash{}, err 1286 } 1287 1288 if args.Nonce == nil { 1289 // Hold the addresse's mutex around signing to prevent concurrent assignment of 1290 // the same nonce to multiple accounts. 1291 s.nonceLock.LockAddr(args.From) 1292 defer s.nonceLock.UnlockAddr(args.From) 1293 } 1294 1295 // Set some sanity defaults and terminate on failure 1296 if err := args.setDefaults(ctx, s.b); err != nil { 1297 return common.Hash{}, err 1298 } 1299 // Assemble the transaction and sign with the wallet 1300 tx := args.toTransaction() 1301 1302 signed, err := wallet.SignTx(account, tx, s.b.ChainConfig().ChainID) 1303 if err != nil { 1304 return common.Hash{}, err 1305 } 1306 return SubmitTransaction(ctx, s.b, signed) 1307 } 1308 1309 // SendRawTransaction will add the signed transaction to the transaction pool. 1310 // The sender is responsible for signing the transaction and using the correct nonce. 1311 func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) { 1312 tx := new(types.Transaction) 1313 if err := rlp.DecodeBytes(encodedTx, tx); err != nil { 1314 return common.Hash{}, err 1315 } 1316 return SubmitTransaction(ctx, s.b, tx) 1317 } 1318 1319 // Sign calculates an ECDSA signature for: 1320 // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message). 1321 // 1322 // Note, the produced signature conforms to the secp256k1 curve R, S and V values, 1323 // where the V value will be 27 or 28 for legacy reasons. 1324 // 1325 // The account associated with addr must be unlocked. 1326 // 1327 // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign 1328 func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) { 1329 // Look up the wallet containing the requested signer 1330 account := accounts.Account{Address: addr} 1331 1332 wallet, err := s.b.AccountManager().Find(account) 1333 if err != nil { 1334 return nil, err 1335 } 1336 // Sign the requested hash with the wallet 1337 signature, err := wallet.SignText(account, data) 1338 if err == nil { 1339 signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper 1340 } 1341 return signature, err 1342 } 1343 1344 // SignTransactionResult represents a RLP encoded signed transaction. 1345 type SignTransactionResult struct { 1346 Raw hexutil.Bytes `json:"raw"` 1347 Tx *types.Transaction `json:"tx"` 1348 } 1349 1350 // SignTransaction will sign the given transaction with the from account. 1351 // The node needs to have the private key of the account corresponding with 1352 // the given from address and it needs to be unlocked. 1353 func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) { 1354 if args.Gas == nil { 1355 return nil, fmt.Errorf("gas not specified") 1356 } 1357 if args.GasPrice == nil { 1358 return nil, fmt.Errorf("gasPrice not specified") 1359 } 1360 if args.Nonce == nil { 1361 return nil, fmt.Errorf("nonce not specified") 1362 } 1363 if err := args.setDefaults(ctx, s.b); err != nil { 1364 return nil, err 1365 } 1366 tx, err := s.sign(args.From, args.toTransaction()) 1367 if err != nil { 1368 return nil, err 1369 } 1370 data, err := rlp.EncodeToBytes(tx) 1371 if err != nil { 1372 return nil, err 1373 } 1374 return &SignTransactionResult{data, tx}, nil 1375 } 1376 1377 // PendingTransactions returns the transactions that are in the transaction pool 1378 // and have a from address that is one of the accounts this node manages. 1379 func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) { 1380 pending, err := s.b.GetPoolTransactions() 1381 if err != nil { 1382 return nil, err 1383 } 1384 accounts := make(map[common.Address]struct{}) 1385 for _, wallet := range s.b.AccountManager().Wallets() { 1386 for _, account := range wallet.Accounts() { 1387 accounts[account.Address] = struct{}{} 1388 } 1389 } 1390 transactions := make([]*RPCTransaction, 0, len(pending)) 1391 for _, tx := range pending { 1392 var signer types.Signer = types.HomesteadSigner{} 1393 if tx.Protected() { 1394 signer = types.NewEIP155Signer(tx.ChainId()) 1395 } 1396 from, _ := types.Sender(signer, tx) 1397 if _, exists := accounts[from]; exists { 1398 transactions = append(transactions, newRPCPendingTransaction(tx)) 1399 } 1400 } 1401 return transactions, nil 1402 } 1403 1404 // Resend accepts an existing transaction and a new gas price and limit. It will remove 1405 // the given transaction from the pool and reinsert it with the new gas price and limit. 1406 func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) { 1407 if sendArgs.Nonce == nil { 1408 return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec") 1409 } 1410 if err := sendArgs.setDefaults(ctx, s.b); err != nil { 1411 return common.Hash{}, err 1412 } 1413 matchTx := sendArgs.toTransaction() 1414 pending, err := s.b.GetPoolTransactions() 1415 if err != nil { 1416 return common.Hash{}, err 1417 } 1418 1419 for _, p := range pending { 1420 var signer types.Signer = types.HomesteadSigner{} 1421 if p.Protected() { 1422 signer = types.NewEIP155Signer(p.ChainId()) 1423 } 1424 wantSigHash := signer.Hash(matchTx) 1425 1426 if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash { 1427 // Match. Re-sign and send the transaction. 1428 if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 { 1429 sendArgs.GasPrice = gasPrice 1430 } 1431 if gasLimit != nil && *gasLimit != 0 { 1432 sendArgs.Gas = gasLimit 1433 } 1434 signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction()) 1435 if err != nil { 1436 return common.Hash{}, err 1437 } 1438 if err = s.b.SendTx(ctx, signedTx); err != nil { 1439 return common.Hash{}, err 1440 } 1441 return signedTx.Hash(), nil 1442 } 1443 } 1444 1445 return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash()) 1446 } 1447 1448 // PublicDebugAPI is the collection of Ethereum APIs exposed over the public 1449 // debugging endpoint. 1450 type PublicDebugAPI struct { 1451 b Backend 1452 } 1453 1454 // NewPublicDebugAPI creates a new API definition for the public debug methods 1455 // of the Ethereum service. 1456 func NewPublicDebugAPI(b Backend) *PublicDebugAPI { 1457 return &PublicDebugAPI{b: b} 1458 } 1459 1460 // GetBlockRlp retrieves the RLP encoded for of a single block. 1461 func (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) { 1462 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1463 if block == nil { 1464 return "", fmt.Errorf("block #%d not found", number) 1465 } 1466 encoded, err := rlp.EncodeToBytes(block) 1467 if err != nil { 1468 return "", err 1469 } 1470 return fmt.Sprintf("%x", encoded), nil 1471 } 1472 1473 // TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the 1474 // given address, returning the address of the recovered signature 1475 // 1476 // This is a temporary method to debug the externalsigner integration, 1477 // TODO: Remove this method when the integration is mature 1478 func (api *PublicDebugAPI) TestSignCliqueBlock(ctx context.Context, address common.Address, number uint64) (common.Address, error) { 1479 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1480 if block == nil { 1481 return common.Address{}, fmt.Errorf("block #%d not found", number) 1482 } 1483 header := block.Header() 1484 header.Extra = make([]byte, 32+65) 1485 encoded := clique.CliqueRLP(header) 1486 1487 // Look up the wallet containing the requested signer 1488 account := accounts.Account{Address: address} 1489 wallet, err := api.b.AccountManager().Find(account) 1490 if err != nil { 1491 return common.Address{}, err 1492 } 1493 1494 signature, err := wallet.SignData(account, accounts.MimetypeClique, encoded) 1495 if err != nil { 1496 return common.Address{}, err 1497 } 1498 sealHash := clique.SealHash(header).Bytes() 1499 log.Info("test signing of clique block", 1500 "Sealhash", fmt.Sprintf("%x", sealHash), 1501 "signature", fmt.Sprintf("%x", signature)) 1502 pubkey, err := crypto.Ecrecover(sealHash, signature) 1503 if err != nil { 1504 return common.Address{}, err 1505 } 1506 var signer common.Address 1507 copy(signer[:], crypto.Keccak256(pubkey[1:])[12:]) 1508 1509 return signer, nil 1510 } 1511 1512 // PrintBlock retrieves a block and returns its pretty printed form. 1513 func (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) { 1514 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1515 if block == nil { 1516 return "", fmt.Errorf("block #%d not found", number) 1517 } 1518 return spew.Sdump(block), nil 1519 } 1520 1521 // SeedHash retrieves the seed hash of a block. 1522 func (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) { 1523 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1524 if block == nil { 1525 return "", fmt.Errorf("block #%d not found", number) 1526 } 1527 return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil 1528 } 1529 1530 // PrivateDebugAPI is the collection of Ethereum APIs exposed over the private 1531 // debugging endpoint. 1532 type PrivateDebugAPI struct { 1533 b Backend 1534 } 1535 1536 // NewPrivateDebugAPI creates a new API definition for the private debug methods 1537 // of the Ethereum service. 1538 func NewPrivateDebugAPI(b Backend) *PrivateDebugAPI { 1539 return &PrivateDebugAPI{b: b} 1540 } 1541 1542 // ChaindbProperty returns leveldb properties of the chain database. 1543 func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) { 1544 ldb, ok := api.b.ChainDb().(interface { 1545 LDB() *leveldb.DB 1546 }) 1547 if !ok { 1548 return "", fmt.Errorf("chaindbProperty does not work for memory databases") 1549 } 1550 if property == "" { 1551 property = "leveldb.stats" 1552 } else if !strings.HasPrefix(property, "leveldb.") { 1553 property = "leveldb." + property 1554 } 1555 return ldb.LDB().GetProperty(property) 1556 } 1557 1558 func (api *PrivateDebugAPI) ChaindbCompact() error { 1559 ldb, ok := api.b.ChainDb().(interface { 1560 LDB() *leveldb.DB 1561 }) 1562 if !ok { 1563 return fmt.Errorf("chaindbCompact does not work for memory databases") 1564 } 1565 for b := byte(0); b < 255; b++ { 1566 log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1)) 1567 err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}}) 1568 if err != nil { 1569 log.Error("Database compaction failed", "err", err) 1570 return err 1571 } 1572 } 1573 return nil 1574 } 1575 1576 // SetHead rewinds the head of the blockchain to a previous block. 1577 func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) { 1578 api.b.SetHead(uint64(number)) 1579 } 1580 1581 // PublicNetAPI offers network related RPC methods 1582 type PublicNetAPI struct { 1583 net *p2p.Server 1584 networkVersion uint64 1585 } 1586 1587 // NewPublicNetAPI creates a new net API instance. 1588 func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI { 1589 return &PublicNetAPI{net, networkVersion} 1590 } 1591 1592 // Listening returns an indication if the node is listening for network connections. 1593 func (s *PublicNetAPI) Listening() bool { 1594 return true // always listening 1595 } 1596 1597 // PeerCount returns the number of connected peers 1598 func (s *PublicNetAPI) PeerCount() hexutil.Uint { 1599 return hexutil.Uint(s.net.PeerCount()) 1600 } 1601 1602 // Version returns the current ethereum protocol version. 1603 func (s *PublicNetAPI) Version() string { 1604 return fmt.Sprintf("%d", s.networkVersion) 1605 }