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