github.com/gnattishness/bazel-go-ethereum@v0.0.0-20190929123618-7022a154f56d/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/accounts/scwallet" 32 "github.com/ethereum/go-ethereum/common" 33 "github.com/ethereum/go-ethereum/common/hexutil" 34 "github.com/ethereum/go-ethereum/common/math" 35 "github.com/ethereum/go-ethereum/consensus/clique" 36 "github.com/ethereum/go-ethereum/consensus/ethash" 37 "github.com/ethereum/go-ethereum/core" 38 "github.com/ethereum/go-ethereum/core/rawdb" 39 "github.com/ethereum/go-ethereum/core/types" 40 "github.com/ethereum/go-ethereum/core/vm" 41 "github.com/ethereum/go-ethereum/crypto" 42 "github.com/ethereum/go-ethereum/log" 43 "github.com/ethereum/go-ethereum/p2p" 44 "github.com/ethereum/go-ethereum/params" 45 "github.com/ethereum/go-ethereum/rlp" 46 "github.com/ethereum/go-ethereum/rpc" 47 "github.com/tyler-smith/go-bip39" 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 return s.am.Accounts() 195 } 196 197 // PrivateAccountAPI provides an API to access accounts managed by this node. 198 // It offers methods to create, (un)lock en list accounts. Some methods accept 199 // passwords and are therefore considered private by default. 200 type PrivateAccountAPI struct { 201 am *accounts.Manager 202 nonceLock *AddrLocker 203 b Backend 204 } 205 206 // NewPrivateAccountAPI create a new PrivateAccountAPI. 207 func NewPrivateAccountAPI(b Backend, nonceLock *AddrLocker) *PrivateAccountAPI { 208 return &PrivateAccountAPI{ 209 am: b.AccountManager(), 210 nonceLock: nonceLock, 211 b: b, 212 } 213 } 214 215 // listAccounts will return a list of addresses for accounts this node manages. 216 func (s *PrivateAccountAPI) ListAccounts() []common.Address { 217 return s.am.Accounts() 218 } 219 220 // rawWallet is a JSON representation of an accounts.Wallet interface, with its 221 // data contents extracted into plain fields. 222 type rawWallet struct { 223 URL string `json:"url"` 224 Status string `json:"status"` 225 Failure string `json:"failure,omitempty"` 226 Accounts []accounts.Account `json:"accounts,omitempty"` 227 } 228 229 // ListWallets will return a list of wallets this node manages. 230 func (s *PrivateAccountAPI) ListWallets() []rawWallet { 231 wallets := make([]rawWallet, 0) // return [] instead of nil if empty 232 for _, wallet := range s.am.Wallets() { 233 status, failure := wallet.Status() 234 235 raw := rawWallet{ 236 URL: wallet.URL().String(), 237 Status: status, 238 Accounts: wallet.Accounts(), 239 } 240 if failure != nil { 241 raw.Failure = failure.Error() 242 } 243 wallets = append(wallets, raw) 244 } 245 return wallets 246 } 247 248 // OpenWallet initiates a hardware wallet opening procedure, establishing a USB 249 // connection and attempting to authenticate via the provided passphrase. Note, 250 // the method may return an extra challenge requiring a second open (e.g. the 251 // Trezor PIN matrix challenge). 252 func (s *PrivateAccountAPI) OpenWallet(url string, passphrase *string) error { 253 wallet, err := s.am.Wallet(url) 254 if err != nil { 255 return err 256 } 257 pass := "" 258 if passphrase != nil { 259 pass = *passphrase 260 } 261 return wallet.Open(pass) 262 } 263 264 // DeriveAccount requests a HD wallet to derive a new account, optionally pinning 265 // it for later reuse. 266 func (s *PrivateAccountAPI) DeriveAccount(url string, path string, pin *bool) (accounts.Account, error) { 267 wallet, err := s.am.Wallet(url) 268 if err != nil { 269 return accounts.Account{}, err 270 } 271 derivPath, err := accounts.ParseDerivationPath(path) 272 if err != nil { 273 return accounts.Account{}, err 274 } 275 if pin == nil { 276 pin = new(bool) 277 } 278 return wallet.Derive(derivPath, *pin) 279 } 280 281 // NewAccount will create a new account and returns the address for the new account. 282 func (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) { 283 acc, err := fetchKeystore(s.am).NewAccount(password) 284 if err == nil { 285 log.Info("Your new key was generated", "address", acc.Address) 286 log.Warn("Please backup your key file!", "path", acc.URL.Path) 287 log.Warn("Please remember your password!") 288 return acc.Address, nil 289 } 290 return common.Address{}, err 291 } 292 293 // fetchKeystore retrives the encrypted keystore from the account manager. 294 func fetchKeystore(am *accounts.Manager) *keystore.KeyStore { 295 return am.Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore) 296 } 297 298 // ImportRawKey stores the given hex encoded ECDSA key into the key directory, 299 // encrypting it with the passphrase. 300 func (s *PrivateAccountAPI) ImportRawKey(privkey string, password string) (common.Address, error) { 301 key, err := crypto.HexToECDSA(privkey) 302 if err != nil { 303 return common.Address{}, err 304 } 305 acc, err := fetchKeystore(s.am).ImportECDSA(key, password) 306 return acc.Address, err 307 } 308 309 // UnlockAccount will unlock the account associated with the given address with 310 // the given password for duration seconds. If duration is nil it will use a 311 // default of 300 seconds. It returns an indication if the account was unlocked. 312 func (s *PrivateAccountAPI) UnlockAccount(ctx context.Context, addr common.Address, password string, duration *uint64) (bool, error) { 313 // When the API is exposed by external RPC(http, ws etc), unless the user 314 // explicitly specifies to allow the insecure account unlocking, otherwise 315 // it is disabled. 316 if s.b.ExtRPCEnabled() && !s.b.AccountManager().Config().InsecureUnlockAllowed { 317 return false, errors.New("account unlock with HTTP access is forbidden") 318 } 319 320 const max = uint64(time.Duration(math.MaxInt64) / time.Second) 321 var d time.Duration 322 if duration == nil { 323 d = 300 * time.Second 324 } else if *duration > max { 325 return false, errors.New("unlock duration too large") 326 } else { 327 d = time.Duration(*duration) * time.Second 328 } 329 err := fetchKeystore(s.am).TimedUnlock(accounts.Account{Address: addr}, password, d) 330 if err != nil { 331 log.Warn("Failed account unlock attempt", "address", addr, "err", err) 332 } 333 return err == nil, err 334 } 335 336 // LockAccount will lock the account associated with the given address when it's unlocked. 337 func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool { 338 return fetchKeystore(s.am).Lock(addr) == nil 339 } 340 341 // signTransaction sets defaults and signs the given transaction 342 // NOTE: the caller needs to ensure that the nonceLock is held, if applicable, 343 // and release it after the transaction has been submitted to the tx pool 344 func (s *PrivateAccountAPI) signTransaction(ctx context.Context, args *SendTxArgs, passwd string) (*types.Transaction, error) { 345 // Look up the wallet containing the requested signer 346 account := accounts.Account{Address: args.From} 347 wallet, err := s.am.Find(account) 348 if err != nil { 349 return nil, err 350 } 351 // Set some sanity defaults and terminate on failure 352 if err := args.setDefaults(ctx, s.b); err != nil { 353 return nil, err 354 } 355 // Assemble the transaction and sign with the wallet 356 tx := args.toTransaction() 357 358 return wallet.SignTxWithPassphrase(account, passwd, tx, s.b.ChainConfig().ChainID) 359 } 360 361 // SendTransaction will create a transaction from the given arguments and 362 // tries to sign it with the key associated with args.To. If the given passwd isn't 363 // able to decrypt the key it fails. 364 func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) { 365 if args.Nonce == nil { 366 // Hold the addresse's mutex around signing to prevent concurrent assignment of 367 // the same nonce to multiple accounts. 368 s.nonceLock.LockAddr(args.From) 369 defer s.nonceLock.UnlockAddr(args.From) 370 } 371 signed, err := s.signTransaction(ctx, &args, passwd) 372 if err != nil { 373 log.Warn("Failed transaction send attempt", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err) 374 return common.Hash{}, err 375 } 376 return SubmitTransaction(ctx, s.b, signed) 377 } 378 379 // SignTransaction will create a transaction from the given arguments and 380 // tries to sign it with the key associated with args.To. If the given passwd isn't 381 // able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast 382 // to other nodes 383 func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args SendTxArgs, passwd string) (*SignTransactionResult, error) { 384 // No need to obtain the noncelock mutex, since we won't be sending this 385 // tx into the transaction pool, but right back to the user 386 if args.Gas == nil { 387 return nil, fmt.Errorf("gas not specified") 388 } 389 if args.GasPrice == nil { 390 return nil, fmt.Errorf("gasPrice not specified") 391 } 392 if args.Nonce == nil { 393 return nil, fmt.Errorf("nonce not specified") 394 } 395 signed, err := s.signTransaction(ctx, &args, passwd) 396 if err != nil { 397 log.Warn("Failed transaction sign attempt", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err) 398 return nil, err 399 } 400 data, err := rlp.EncodeToBytes(signed) 401 if err != nil { 402 return nil, err 403 } 404 return &SignTransactionResult{data, signed}, nil 405 } 406 407 // Sign calculates an Ethereum ECDSA signature for: 408 // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message)) 409 // 410 // Note, the produced signature conforms to the secp256k1 curve R, S and V values, 411 // where the V value will be 27 or 28 for legacy reasons. 412 // 413 // The key used to calculate the signature is decrypted with the given password. 414 // 415 // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign 416 func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) { 417 // Look up the wallet containing the requested signer 418 account := accounts.Account{Address: addr} 419 420 wallet, err := s.b.AccountManager().Find(account) 421 if err != nil { 422 return nil, err 423 } 424 // Assemble sign the data with the wallet 425 signature, err := wallet.SignTextWithPassphrase(account, passwd, data) 426 if err != nil { 427 log.Warn("Failed data sign attempt", "address", addr, "err", err) 428 return nil, err 429 } 430 signature[crypto.RecoveryIDOffset] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper 431 return signature, nil 432 } 433 434 // EcRecover returns the address for the account that was used to create the signature. 435 // Note, this function is compatible with eth_sign and personal_sign. As such it recovers 436 // the address of: 437 // hash = keccak256("\x19Ethereum Signed Message:\n"${message length}${message}) 438 // addr = ecrecover(hash, signature) 439 // 440 // Note, the signature must conform to the secp256k1 curve R, S and V values, where 441 // the V value must be 27 or 28 for legacy reasons. 442 // 443 // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover 444 func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) { 445 if len(sig) != crypto.SignatureLength { 446 return common.Address{}, fmt.Errorf("signature must be %d bytes long", crypto.SignatureLength) 447 } 448 if sig[crypto.RecoveryIDOffset] != 27 && sig[crypto.RecoveryIDOffset] != 28 { 449 return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)") 450 } 451 sig[crypto.RecoveryIDOffset] -= 27 // Transform yellow paper V from 27/28 to 0/1 452 453 rpk, err := crypto.SigToPub(accounts.TextHash(data), sig) 454 if err != nil { 455 return common.Address{}, err 456 } 457 return crypto.PubkeyToAddress(*rpk), nil 458 } 459 460 // SignAndSendTransaction was renamed to SendTransaction. This method is deprecated 461 // and will be removed in the future. It primary goal is to give clients time to update. 462 func (s *PrivateAccountAPI) SignAndSendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) { 463 return s.SendTransaction(ctx, args, passwd) 464 } 465 466 // InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key. 467 func (s *PrivateAccountAPI) InitializeWallet(ctx context.Context, url string) (string, error) { 468 wallet, err := s.am.Wallet(url) 469 if err != nil { 470 return "", err 471 } 472 473 entropy, err := bip39.NewEntropy(256) 474 if err != nil { 475 return "", err 476 } 477 478 mnemonic, err := bip39.NewMnemonic(entropy) 479 if err != nil { 480 return "", err 481 } 482 483 seed := bip39.NewSeed(mnemonic, "") 484 485 switch wallet := wallet.(type) { 486 case *scwallet.Wallet: 487 return mnemonic, wallet.Initialize(seed) 488 default: 489 return "", fmt.Errorf("Specified wallet does not support initialization") 490 } 491 } 492 493 // Unpair deletes a pairing between wallet and geth. 494 func (s *PrivateAccountAPI) Unpair(ctx context.Context, url string, pin string) error { 495 wallet, err := s.am.Wallet(url) 496 if err != nil { 497 return err 498 } 499 500 switch wallet := wallet.(type) { 501 case *scwallet.Wallet: 502 return wallet.Unpair([]byte(pin)) 503 default: 504 return fmt.Errorf("Specified wallet does not support pairing") 505 } 506 } 507 508 // PublicBlockChainAPI provides an API to access the Ethereum blockchain. 509 // It offers only methods that operate on public data that is freely available to anyone. 510 type PublicBlockChainAPI struct { 511 b Backend 512 } 513 514 // NewPublicBlockChainAPI creates a new Ethereum blockchain API. 515 func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI { 516 return &PublicBlockChainAPI{b} 517 } 518 519 // ChainId returns the chainID value for transaction replay protection. 520 func (s *PublicBlockChainAPI) ChainId() *hexutil.Big { 521 return (*hexutil.Big)(s.b.ChainConfig().ChainID) 522 } 523 524 // BlockNumber returns the block number of the chain head. 525 func (s *PublicBlockChainAPI) BlockNumber() hexutil.Uint64 { 526 header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available 527 return hexutil.Uint64(header.Number.Uint64()) 528 } 529 530 // GetBalance returns the amount of wei for the given address in the state of the 531 // given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta 532 // block numbers are also allowed. 533 func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Big, error) { 534 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 535 if state == nil || err != nil { 536 return nil, err 537 } 538 return (*hexutil.Big)(state.GetBalance(address)), state.Error() 539 } 540 541 // Result structs for GetProof 542 type AccountResult struct { 543 Address common.Address `json:"address"` 544 AccountProof []string `json:"accountProof"` 545 Balance *hexutil.Big `json:"balance"` 546 CodeHash common.Hash `json:"codeHash"` 547 Nonce hexutil.Uint64 `json:"nonce"` 548 StorageHash common.Hash `json:"storageHash"` 549 StorageProof []StorageResult `json:"storageProof"` 550 } 551 type StorageResult struct { 552 Key string `json:"key"` 553 Value *hexutil.Big `json:"value"` 554 Proof []string `json:"proof"` 555 } 556 557 // GetProof returns the Merkle-proof for a given account and optionally some storage keys. 558 func (s *PublicBlockChainAPI) GetProof(ctx context.Context, address common.Address, storageKeys []string, blockNr rpc.BlockNumber) (*AccountResult, error) { 559 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 560 if state == nil || err != nil { 561 return nil, err 562 } 563 564 storageTrie := state.StorageTrie(address) 565 storageHash := types.EmptyRootHash 566 codeHash := state.GetCodeHash(address) 567 storageProof := make([]StorageResult, len(storageKeys)) 568 569 // if we have a storageTrie, (which means the account exists), we can update the storagehash 570 if storageTrie != nil { 571 storageHash = storageTrie.Hash() 572 } else { 573 // no storageTrie means the account does not exist, so the codeHash is the hash of an empty bytearray. 574 codeHash = crypto.Keccak256Hash(nil) 575 } 576 577 // create the proof for the storageKeys 578 for i, key := range storageKeys { 579 if storageTrie != nil { 580 proof, storageError := state.GetStorageProof(address, common.HexToHash(key)) 581 if storageError != nil { 582 return nil, storageError 583 } 584 storageProof[i] = StorageResult{key, (*hexutil.Big)(state.GetState(address, common.HexToHash(key)).Big()), common.ToHexArray(proof)} 585 } else { 586 storageProof[i] = StorageResult{key, &hexutil.Big{}, []string{}} 587 } 588 } 589 590 // create the accountProof 591 accountProof, proofErr := state.GetProof(address) 592 if proofErr != nil { 593 return nil, proofErr 594 } 595 596 return &AccountResult{ 597 Address: address, 598 AccountProof: common.ToHexArray(accountProof), 599 Balance: (*hexutil.Big)(state.GetBalance(address)), 600 CodeHash: codeHash, 601 Nonce: hexutil.Uint64(state.GetNonce(address)), 602 StorageHash: storageHash, 603 StorageProof: storageProof, 604 }, state.Error() 605 } 606 607 // GetHeaderByNumber returns the requested canonical block header. 608 // * When blockNr is -1 the chain head is returned. 609 // * When blockNr is -2 the pending chain head is returned. 610 func (s *PublicBlockChainAPI) GetHeaderByNumber(ctx context.Context, number rpc.BlockNumber) (map[string]interface{}, error) { 611 header, err := s.b.HeaderByNumber(ctx, number) 612 if header != nil && err == nil { 613 response := s.rpcMarshalHeader(header) 614 if number == rpc.PendingBlockNumber { 615 // Pending header need to nil out a few fields 616 for _, field := range []string{"hash", "nonce", "miner"} { 617 response[field] = nil 618 } 619 } 620 return response, err 621 } 622 return nil, err 623 } 624 625 // GetHeaderByHash returns the requested header by hash. 626 func (s *PublicBlockChainAPI) GetHeaderByHash(ctx context.Context, hash common.Hash) map[string]interface{} { 627 header, _ := s.b.HeaderByHash(ctx, hash) 628 if header != nil { 629 return s.rpcMarshalHeader(header) 630 } 631 return nil 632 } 633 634 // GetBlockByNumber returns the requested canonical block. 635 // * When blockNr is -1 the chain head is returned. 636 // * When blockNr is -2 the pending chain head is returned. 637 // * When fullTx is true all transactions in the block are returned, otherwise 638 // only the transaction hash is returned. 639 func (s *PublicBlockChainAPI) GetBlockByNumber(ctx context.Context, number rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) { 640 block, err := s.b.BlockByNumber(ctx, number) 641 if block != nil && err == nil { 642 response, err := s.rpcMarshalBlock(block, true, fullTx) 643 if err == nil && number == rpc.PendingBlockNumber { 644 // Pending blocks need to nil out a few fields 645 for _, field := range []string{"hash", "nonce", "miner"} { 646 response[field] = nil 647 } 648 } 649 return response, err 650 } 651 return nil, err 652 } 653 654 // GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full 655 // detail, otherwise only the transaction hash is returned. 656 func (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, hash common.Hash, fullTx bool) (map[string]interface{}, error) { 657 block, err := s.b.BlockByHash(ctx, hash) 658 if block != nil { 659 return s.rpcMarshalBlock(block, true, fullTx) 660 } 661 return nil, err 662 } 663 664 // GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true 665 // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 666 func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) { 667 block, err := s.b.BlockByNumber(ctx, blockNr) 668 if block != nil { 669 uncles := block.Uncles() 670 if index >= hexutil.Uint(len(uncles)) { 671 log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index) 672 return nil, nil 673 } 674 block = types.NewBlockWithHeader(uncles[index]) 675 return s.rpcMarshalBlock(block, false, false) 676 } 677 return nil, err 678 } 679 680 // GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true 681 // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 682 func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) { 683 block, err := s.b.BlockByHash(ctx, blockHash) 684 if block != nil { 685 uncles := block.Uncles() 686 if index >= hexutil.Uint(len(uncles)) { 687 log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index) 688 return nil, nil 689 } 690 block = types.NewBlockWithHeader(uncles[index]) 691 return s.rpcMarshalBlock(block, false, false) 692 } 693 return nil, err 694 } 695 696 // GetUncleCountByBlockNumber returns number of uncles in the block for the given block number 697 func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint { 698 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 699 n := hexutil.Uint(len(block.Uncles())) 700 return &n 701 } 702 return nil 703 } 704 705 // GetUncleCountByBlockHash returns number of uncles in the block for the given block hash 706 func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint { 707 if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil { 708 n := hexutil.Uint(len(block.Uncles())) 709 return &n 710 } 711 return nil 712 } 713 714 // GetCode returns the code stored at the given address in the state for the given block number. 715 func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (hexutil.Bytes, error) { 716 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 717 if state == nil || err != nil { 718 return nil, err 719 } 720 code := state.GetCode(address) 721 return code, state.Error() 722 } 723 724 // GetStorageAt returns the storage from the state at the given address, key and 725 // block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block 726 // numbers are also allowed. 727 func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNr rpc.BlockNumber) (hexutil.Bytes, error) { 728 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 729 if state == nil || err != nil { 730 return nil, err 731 } 732 res := state.GetState(address, common.HexToHash(key)) 733 return res[:], state.Error() 734 } 735 736 // CallArgs represents the arguments for a call. 737 type CallArgs struct { 738 From *common.Address `json:"from"` 739 To *common.Address `json:"to"` 740 Gas *hexutil.Uint64 `json:"gas"` 741 GasPrice *hexutil.Big `json:"gasPrice"` 742 Value *hexutil.Big `json:"value"` 743 Data *hexutil.Bytes `json:"data"` 744 } 745 746 // account indicates the overriding fields of account during the execution of 747 // a message call. 748 // Note, state and stateDiff can't be specified at the same time. If state is 749 // set, message execution will only use the data in the given state. Otherwise 750 // if statDiff is set, all diff will be applied first and then execute the call 751 // message. 752 type account struct { 753 Nonce *hexutil.Uint64 `json:"nonce"` 754 Code *hexutil.Bytes `json:"code"` 755 Balance **hexutil.Big `json:"balance"` 756 State *map[common.Hash]common.Hash `json:"state"` 757 StateDiff *map[common.Hash]common.Hash `json:"stateDiff"` 758 } 759 760 func DoCall(ctx context.Context, b Backend, args CallArgs, blockNr rpc.BlockNumber, overrides map[common.Address]account, vmCfg vm.Config, timeout time.Duration, globalGasCap *big.Int) ([]byte, uint64, bool, error) { 761 defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now()) 762 763 state, header, err := b.StateAndHeaderByNumber(ctx, blockNr) 764 if state == nil || err != nil { 765 return nil, 0, false, err 766 } 767 // Set sender address or use a default if none specified 768 var addr common.Address 769 if args.From == nil { 770 if wallets := b.AccountManager().Wallets(); len(wallets) > 0 { 771 if accounts := wallets[0].Accounts(); len(accounts) > 0 { 772 addr = accounts[0].Address 773 } 774 } 775 } else { 776 addr = *args.From 777 } 778 // Override the fields of specified contracts before execution. 779 for addr, account := range overrides { 780 // Override account nonce. 781 if account.Nonce != nil { 782 state.SetNonce(addr, uint64(*account.Nonce)) 783 } 784 // Override account(contract) code. 785 if account.Code != nil { 786 state.SetCode(addr, *account.Code) 787 } 788 // Override account balance. 789 if account.Balance != nil { 790 state.SetBalance(addr, (*big.Int)(*account.Balance)) 791 } 792 if account.State != nil && account.StateDiff != nil { 793 return nil, 0, false, fmt.Errorf("account %s has both 'state' and 'stateDiff'", addr.Hex()) 794 } 795 // Replace entire state if caller requires. 796 if account.State != nil { 797 state.SetStorage(addr, *account.State) 798 } 799 // Apply state diff into specified accounts. 800 if account.StateDiff != nil { 801 for key, value := range *account.StateDiff { 802 state.SetState(addr, key, value) 803 } 804 } 805 } 806 // Set default gas & gas price if none were set 807 gas := uint64(math.MaxUint64 / 2) 808 if args.Gas != nil { 809 gas = uint64(*args.Gas) 810 } 811 if globalGasCap != nil && globalGasCap.Uint64() < gas { 812 log.Warn("Caller gas above allowance, capping", "requested", gas, "cap", globalGasCap) 813 gas = globalGasCap.Uint64() 814 } 815 gasPrice := new(big.Int).SetUint64(defaultGasPrice) 816 if args.GasPrice != nil { 817 gasPrice = args.GasPrice.ToInt() 818 } 819 820 value := new(big.Int) 821 if args.Value != nil { 822 value = args.Value.ToInt() 823 } 824 825 var data []byte 826 if args.Data != nil { 827 data = []byte(*args.Data) 828 } 829 830 // Create new call message 831 msg := types.NewMessage(addr, args.To, 0, value, gas, gasPrice, data, false) 832 833 // Setup context so it may be cancelled the call has completed 834 // or, in case of unmetered gas, setup a context with a timeout. 835 var cancel context.CancelFunc 836 if timeout > 0 { 837 ctx, cancel = context.WithTimeout(ctx, timeout) 838 } else { 839 ctx, cancel = context.WithCancel(ctx) 840 } 841 // Make sure the context is cancelled when the call has completed 842 // this makes sure resources are cleaned up. 843 defer cancel() 844 845 // Get a new instance of the EVM. 846 evm, vmError, err := b.GetEVM(ctx, msg, state, header) 847 if err != nil { 848 return nil, 0, false, err 849 } 850 // Wait for the context to be done and cancel the evm. Even if the 851 // EVM has finished, cancelling may be done (repeatedly) 852 go func() { 853 <-ctx.Done() 854 evm.Cancel() 855 }() 856 857 // Setup the gas pool (also for unmetered requests) 858 // and apply the message. 859 gp := new(core.GasPool).AddGas(math.MaxUint64) 860 res, gas, failed, err := core.ApplyMessage(evm, msg, gp) 861 if err := vmError(); err != nil { 862 return nil, 0, false, err 863 } 864 // If the timer caused an abort, return an appropriate error message 865 if evm.Cancelled() { 866 return nil, 0, false, fmt.Errorf("execution aborted (timeout = %v)", timeout) 867 } 868 return res, gas, failed, err 869 } 870 871 // Call executes the given transaction on the state for the given block number. 872 // 873 // Additionally, the caller can specify a batch of contract for fields overriding. 874 // 875 // Note, this function doesn't make and changes in the state/blockchain and is 876 // useful to execute and retrieve values. 877 func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber, overrides *map[common.Address]account) (hexutil.Bytes, error) { 878 var accounts map[common.Address]account 879 if overrides != nil { 880 accounts = *overrides 881 } 882 result, _, _, err := DoCall(ctx, s.b, args, blockNr, accounts, vm.Config{}, 5*time.Second, s.b.RPCGasCap()) 883 return (hexutil.Bytes)(result), err 884 } 885 886 func DoEstimateGas(ctx context.Context, b Backend, args CallArgs, blockNr rpc.BlockNumber, gasCap *big.Int) (hexutil.Uint64, error) { 887 // Binary search the gas requirement, as it may be higher than the amount used 888 var ( 889 lo uint64 = params.TxGas - 1 890 hi uint64 891 cap uint64 892 ) 893 if args.Gas != nil && uint64(*args.Gas) >= params.TxGas { 894 hi = uint64(*args.Gas) 895 } else { 896 // Retrieve the block to act as the gas ceiling 897 block, err := b.BlockByNumber(ctx, blockNr) 898 if err != nil { 899 return 0, err 900 } 901 hi = block.GasLimit() 902 } 903 if gasCap != nil && hi > gasCap.Uint64() { 904 log.Warn("Caller gas above allowance, capping", "requested", hi, "cap", gasCap) 905 hi = gasCap.Uint64() 906 } 907 cap = hi 908 909 // Create a helper to check if a gas allowance results in an executable transaction 910 executable := func(gas uint64) bool { 911 args.Gas = (*hexutil.Uint64)(&gas) 912 913 _, _, failed, err := DoCall(ctx, b, args, rpc.PendingBlockNumber, nil, vm.Config{}, 0, gasCap) 914 if err != nil || failed { 915 return false 916 } 917 return true 918 } 919 // Execute the binary search and hone in on an executable gas limit 920 for lo+1 < hi { 921 mid := (hi + lo) / 2 922 if !executable(mid) { 923 lo = mid 924 } else { 925 hi = mid 926 } 927 } 928 // Reject the transaction as invalid if it still fails at the highest allowance 929 if hi == cap { 930 if !executable(hi) { 931 return 0, fmt.Errorf("gas required exceeds allowance (%d) or always failing transaction", cap) 932 } 933 } 934 return hexutil.Uint64(hi), nil 935 } 936 937 // EstimateGas returns an estimate of the amount of gas needed to execute the 938 // given transaction against the current pending block. 939 func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (hexutil.Uint64, error) { 940 return DoEstimateGas(ctx, s.b, args, rpc.PendingBlockNumber, s.b.RPCGasCap()) 941 } 942 943 // ExecutionResult groups all structured logs emitted by the EVM 944 // while replaying a transaction in debug mode as well as transaction 945 // execution status, the amount of gas used and the return value 946 type ExecutionResult struct { 947 Gas uint64 `json:"gas"` 948 Failed bool `json:"failed"` 949 ReturnValue string `json:"returnValue"` 950 StructLogs []StructLogRes `json:"structLogs"` 951 } 952 953 // StructLogRes stores a structured log emitted by the EVM while replaying a 954 // transaction in debug mode 955 type StructLogRes struct { 956 Pc uint64 `json:"pc"` 957 Op string `json:"op"` 958 Gas uint64 `json:"gas"` 959 GasCost uint64 `json:"gasCost"` 960 Depth int `json:"depth"` 961 Error error `json:"error,omitempty"` 962 Stack *[]string `json:"stack,omitempty"` 963 Memory *[]string `json:"memory,omitempty"` 964 Storage *map[string]string `json:"storage,omitempty"` 965 } 966 967 // FormatLogs formats EVM returned structured logs for json output 968 func FormatLogs(logs []vm.StructLog) []StructLogRes { 969 formatted := make([]StructLogRes, len(logs)) 970 for index, trace := range logs { 971 formatted[index] = StructLogRes{ 972 Pc: trace.Pc, 973 Op: trace.Op.String(), 974 Gas: trace.Gas, 975 GasCost: trace.GasCost, 976 Depth: trace.Depth, 977 Error: trace.Err, 978 } 979 if trace.Stack != nil { 980 stack := make([]string, len(trace.Stack)) 981 for i, stackValue := range trace.Stack { 982 stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32)) 983 } 984 formatted[index].Stack = &stack 985 } 986 if trace.Memory != nil { 987 memory := make([]string, 0, (len(trace.Memory)+31)/32) 988 for i := 0; i+32 <= len(trace.Memory); i += 32 { 989 memory = append(memory, fmt.Sprintf("%x", trace.Memory[i:i+32])) 990 } 991 formatted[index].Memory = &memory 992 } 993 if trace.Storage != nil { 994 storage := make(map[string]string) 995 for i, storageValue := range trace.Storage { 996 storage[fmt.Sprintf("%x", i)] = fmt.Sprintf("%x", storageValue) 997 } 998 formatted[index].Storage = &storage 999 } 1000 } 1001 return formatted 1002 } 1003 1004 // RPCMarshalHeader converts the given header to the RPC output . 1005 func RPCMarshalHeader(head *types.Header) map[string]interface{} { 1006 return map[string]interface{}{ 1007 "number": (*hexutil.Big)(head.Number), 1008 "hash": head.Hash(), 1009 "parentHash": head.ParentHash, 1010 "nonce": head.Nonce, 1011 "mixHash": head.MixDigest, 1012 "sha3Uncles": head.UncleHash, 1013 "logsBloom": head.Bloom, 1014 "stateRoot": head.Root, 1015 "miner": head.Coinbase, 1016 "difficulty": (*hexutil.Big)(head.Difficulty), 1017 "extraData": hexutil.Bytes(head.Extra), 1018 "size": hexutil.Uint64(head.Size()), 1019 "gasLimit": hexutil.Uint64(head.GasLimit), 1020 "gasUsed": hexutil.Uint64(head.GasUsed), 1021 "timestamp": hexutil.Uint64(head.Time), 1022 "transactionsRoot": head.TxHash, 1023 "receiptsRoot": head.ReceiptHash, 1024 } 1025 } 1026 1027 // RPCMarshalBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are 1028 // returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain 1029 // transaction hashes. 1030 func RPCMarshalBlock(block *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) { 1031 fields := RPCMarshalHeader(block.Header()) 1032 fields["size"] = hexutil.Uint64(block.Size()) 1033 1034 if inclTx { 1035 formatTx := func(tx *types.Transaction) (interface{}, error) { 1036 return tx.Hash(), nil 1037 } 1038 if fullTx { 1039 formatTx = func(tx *types.Transaction) (interface{}, error) { 1040 return newRPCTransactionFromBlockHash(block, tx.Hash()), nil 1041 } 1042 } 1043 txs := block.Transactions() 1044 transactions := make([]interface{}, len(txs)) 1045 var err error 1046 for i, tx := range txs { 1047 if transactions[i], err = formatTx(tx); err != nil { 1048 return nil, err 1049 } 1050 } 1051 fields["transactions"] = transactions 1052 } 1053 uncles := block.Uncles() 1054 uncleHashes := make([]common.Hash, len(uncles)) 1055 for i, uncle := range uncles { 1056 uncleHashes[i] = uncle.Hash() 1057 } 1058 fields["uncles"] = uncleHashes 1059 1060 return fields, nil 1061 } 1062 1063 // rpcMarshalHeader uses the generalized output filler, then adds the total difficulty field, which requires 1064 // a `PublicBlockchainAPI`. 1065 func (s *PublicBlockChainAPI) rpcMarshalHeader(header *types.Header) map[string]interface{} { 1066 fields := RPCMarshalHeader(header) 1067 fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(header.Hash())) 1068 return fields 1069 } 1070 1071 // rpcMarshalBlock uses the generalized output filler, then adds the total difficulty field, which requires 1072 // a `PublicBlockchainAPI`. 1073 func (s *PublicBlockChainAPI) rpcMarshalBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) { 1074 fields, err := RPCMarshalBlock(b, inclTx, fullTx) 1075 if err != nil { 1076 return nil, err 1077 } 1078 fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(b.Hash())) 1079 return fields, err 1080 } 1081 1082 // RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction 1083 type RPCTransaction struct { 1084 BlockHash *common.Hash `json:"blockHash"` 1085 BlockNumber *hexutil.Big `json:"blockNumber"` 1086 From common.Address `json:"from"` 1087 Gas hexutil.Uint64 `json:"gas"` 1088 GasPrice *hexutil.Big `json:"gasPrice"` 1089 Hash common.Hash `json:"hash"` 1090 Input hexutil.Bytes `json:"input"` 1091 Nonce hexutil.Uint64 `json:"nonce"` 1092 To *common.Address `json:"to"` 1093 TransactionIndex *hexutil.Uint64 `json:"transactionIndex"` 1094 Value *hexutil.Big `json:"value"` 1095 V *hexutil.Big `json:"v"` 1096 R *hexutil.Big `json:"r"` 1097 S *hexutil.Big `json:"s"` 1098 } 1099 1100 // newRPCTransaction returns a transaction that will serialize to the RPC 1101 // representation, with the given location metadata set (if available). 1102 func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64) *RPCTransaction { 1103 var signer types.Signer = types.FrontierSigner{} 1104 if tx.Protected() { 1105 signer = types.NewEIP155Signer(tx.ChainId()) 1106 } 1107 from, _ := types.Sender(signer, tx) 1108 v, r, s := tx.RawSignatureValues() 1109 1110 result := &RPCTransaction{ 1111 From: from, 1112 Gas: hexutil.Uint64(tx.Gas()), 1113 GasPrice: (*hexutil.Big)(tx.GasPrice()), 1114 Hash: tx.Hash(), 1115 Input: hexutil.Bytes(tx.Data()), 1116 Nonce: hexutil.Uint64(tx.Nonce()), 1117 To: tx.To(), 1118 Value: (*hexutil.Big)(tx.Value()), 1119 V: (*hexutil.Big)(v), 1120 R: (*hexutil.Big)(r), 1121 S: (*hexutil.Big)(s), 1122 } 1123 if blockHash != (common.Hash{}) { 1124 result.BlockHash = &blockHash 1125 result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber)) 1126 result.TransactionIndex = (*hexutil.Uint64)(&index) 1127 } 1128 return result 1129 } 1130 1131 // newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation 1132 func newRPCPendingTransaction(tx *types.Transaction) *RPCTransaction { 1133 return newRPCTransaction(tx, common.Hash{}, 0, 0) 1134 } 1135 1136 // newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation. 1137 func newRPCTransactionFromBlockIndex(b *types.Block, index uint64) *RPCTransaction { 1138 txs := b.Transactions() 1139 if index >= uint64(len(txs)) { 1140 return nil 1141 } 1142 return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index) 1143 } 1144 1145 // newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index. 1146 func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes { 1147 txs := b.Transactions() 1148 if index >= uint64(len(txs)) { 1149 return nil 1150 } 1151 blob, _ := rlp.EncodeToBytes(txs[index]) 1152 return blob 1153 } 1154 1155 // newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation. 1156 func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction { 1157 for idx, tx := range b.Transactions() { 1158 if tx.Hash() == hash { 1159 return newRPCTransactionFromBlockIndex(b, uint64(idx)) 1160 } 1161 } 1162 return nil 1163 } 1164 1165 // PublicTransactionPoolAPI exposes methods for the RPC interface 1166 type PublicTransactionPoolAPI struct { 1167 b Backend 1168 nonceLock *AddrLocker 1169 } 1170 1171 // NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool. 1172 func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI { 1173 return &PublicTransactionPoolAPI{b, nonceLock} 1174 } 1175 1176 // GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number. 1177 func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint { 1178 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 1179 n := hexutil.Uint(len(block.Transactions())) 1180 return &n 1181 } 1182 return nil 1183 } 1184 1185 // GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash. 1186 func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint { 1187 if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil { 1188 n := hexutil.Uint(len(block.Transactions())) 1189 return &n 1190 } 1191 return nil 1192 } 1193 1194 // GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index. 1195 func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction { 1196 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 1197 return newRPCTransactionFromBlockIndex(block, uint64(index)) 1198 } 1199 return nil 1200 } 1201 1202 // GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index. 1203 func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction { 1204 if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil { 1205 return newRPCTransactionFromBlockIndex(block, uint64(index)) 1206 } 1207 return nil 1208 } 1209 1210 // GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index. 1211 func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes { 1212 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 1213 return newRPCRawTransactionFromBlockIndex(block, uint64(index)) 1214 } 1215 return nil 1216 } 1217 1218 // GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index. 1219 func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes { 1220 if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil { 1221 return newRPCRawTransactionFromBlockIndex(block, uint64(index)) 1222 } 1223 return nil 1224 } 1225 1226 // GetTransactionCount returns the number of transactions the given address has sent for the given block number 1227 func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) { 1228 // Ask transaction pool for the nonce which includes pending transactions 1229 if blockNr == rpc.PendingBlockNumber { 1230 nonce, err := s.b.GetPoolNonce(ctx, address) 1231 if err != nil { 1232 return nil, err 1233 } 1234 return (*hexutil.Uint64)(&nonce), nil 1235 } 1236 // Resolve block number and use its state to ask for the nonce 1237 state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr) 1238 if state == nil || err != nil { 1239 return nil, err 1240 } 1241 nonce := state.GetNonce(address) 1242 return (*hexutil.Uint64)(&nonce), state.Error() 1243 } 1244 1245 // GetTransactionByHash returns the transaction for the given hash 1246 func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) (*RPCTransaction, error) { 1247 // Try to return an already finalized transaction 1248 tx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash) 1249 if err != nil { 1250 return nil, err 1251 } 1252 if tx != nil { 1253 return newRPCTransaction(tx, blockHash, blockNumber, index), nil 1254 } 1255 // No finalized transaction, try to retrieve it from the pool 1256 if tx := s.b.GetPoolTransaction(hash); tx != nil { 1257 return newRPCPendingTransaction(tx), nil 1258 } 1259 1260 // Transaction unknown, return as such 1261 return nil, nil 1262 } 1263 1264 // GetRawTransactionByHash returns the bytes of the transaction for the given hash. 1265 func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) { 1266 // Retrieve a finalized transaction, or a pooled otherwise 1267 tx, _, _, _, err := s.b.GetTransaction(ctx, hash) 1268 if err != nil { 1269 return nil, err 1270 } 1271 if tx == nil { 1272 if tx = s.b.GetPoolTransaction(hash); tx == nil { 1273 // Transaction not found anywhere, abort 1274 return nil, nil 1275 } 1276 } 1277 // Serialize to RLP and return 1278 return rlp.EncodeToBytes(tx) 1279 } 1280 1281 // GetTransactionReceipt returns the transaction receipt for the given transaction hash. 1282 func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) { 1283 tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash) 1284 if tx == nil { 1285 return nil, nil 1286 } 1287 receipts, err := s.b.GetReceipts(ctx, blockHash) 1288 if err != nil { 1289 return nil, err 1290 } 1291 if len(receipts) <= int(index) { 1292 return nil, nil 1293 } 1294 receipt := receipts[index] 1295 1296 var signer types.Signer = types.FrontierSigner{} 1297 if tx.Protected() { 1298 signer = types.NewEIP155Signer(tx.ChainId()) 1299 } 1300 from, _ := types.Sender(signer, tx) 1301 1302 fields := map[string]interface{}{ 1303 "blockHash": blockHash, 1304 "blockNumber": hexutil.Uint64(blockNumber), 1305 "transactionHash": hash, 1306 "transactionIndex": hexutil.Uint64(index), 1307 "from": from, 1308 "to": tx.To(), 1309 "gasUsed": hexutil.Uint64(receipt.GasUsed), 1310 "cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed), 1311 "contractAddress": nil, 1312 "logs": receipt.Logs, 1313 "logsBloom": receipt.Bloom, 1314 } 1315 1316 // Assign receipt status or post state. 1317 if len(receipt.PostState) > 0 { 1318 fields["root"] = hexutil.Bytes(receipt.PostState) 1319 } else { 1320 fields["status"] = hexutil.Uint(receipt.Status) 1321 } 1322 if receipt.Logs == nil { 1323 fields["logs"] = [][]*types.Log{} 1324 } 1325 // If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation 1326 if receipt.ContractAddress != (common.Address{}) { 1327 fields["contractAddress"] = receipt.ContractAddress 1328 } 1329 return fields, nil 1330 } 1331 1332 // sign is a helper function that signs a transaction with the private key of the given address. 1333 func (s *PublicTransactionPoolAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) { 1334 // Look up the wallet containing the requested signer 1335 account := accounts.Account{Address: addr} 1336 1337 wallet, err := s.b.AccountManager().Find(account) 1338 if err != nil { 1339 return nil, err 1340 } 1341 // Request the wallet to sign the transaction 1342 return wallet.SignTx(account, tx, s.b.ChainConfig().ChainID) 1343 } 1344 1345 // SendTxArgs represents the arguments to sumbit a new transaction into the transaction pool. 1346 type SendTxArgs struct { 1347 From common.Address `json:"from"` 1348 To *common.Address `json:"to"` 1349 Gas *hexutil.Uint64 `json:"gas"` 1350 GasPrice *hexutil.Big `json:"gasPrice"` 1351 Value *hexutil.Big `json:"value"` 1352 Nonce *hexutil.Uint64 `json:"nonce"` 1353 // We accept "data" and "input" for backwards-compatibility reasons. "input" is the 1354 // newer name and should be preferred by clients. 1355 Data *hexutil.Bytes `json:"data"` 1356 Input *hexutil.Bytes `json:"input"` 1357 } 1358 1359 // setDefaults is a helper function that fills in default values for unspecified tx fields. 1360 func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error { 1361 if args.GasPrice == nil { 1362 price, err := b.SuggestPrice(ctx) 1363 if err != nil { 1364 return err 1365 } 1366 args.GasPrice = (*hexutil.Big)(price) 1367 } 1368 if args.Value == nil { 1369 args.Value = new(hexutil.Big) 1370 } 1371 if args.Nonce == nil { 1372 nonce, err := b.GetPoolNonce(ctx, args.From) 1373 if err != nil { 1374 return err 1375 } 1376 args.Nonce = (*hexutil.Uint64)(&nonce) 1377 } 1378 if args.Data != nil && args.Input != nil && !bytes.Equal(*args.Data, *args.Input) { 1379 return errors.New(`Both "data" and "input" are set and not equal. Please use "input" to pass transaction call data.`) 1380 } 1381 if args.To == nil { 1382 // Contract creation 1383 var input []byte 1384 if args.Data != nil { 1385 input = *args.Data 1386 } else if args.Input != nil { 1387 input = *args.Input 1388 } 1389 if len(input) == 0 { 1390 return errors.New(`contract creation without any data provided`) 1391 } 1392 } 1393 // Estimate the gas usage if necessary. 1394 if args.Gas == nil { 1395 // For backwards-compatibility reason, we try both input and data 1396 // but input is preferred. 1397 input := args.Input 1398 if input == nil { 1399 input = args.Data 1400 } 1401 callArgs := CallArgs{ 1402 From: &args.From, // From shouldn't be nil 1403 To: args.To, 1404 GasPrice: args.GasPrice, 1405 Value: args.Value, 1406 Data: input, 1407 } 1408 estimated, err := DoEstimateGas(ctx, b, callArgs, rpc.PendingBlockNumber, b.RPCGasCap()) 1409 if err != nil { 1410 return err 1411 } 1412 args.Gas = &estimated 1413 log.Trace("Estimate gas usage automatically", "gas", args.Gas) 1414 } 1415 return nil 1416 } 1417 1418 func (args *SendTxArgs) toTransaction() *types.Transaction { 1419 var input []byte 1420 if args.Input != nil { 1421 input = *args.Input 1422 } else if args.Data != nil { 1423 input = *args.Data 1424 } 1425 if args.To == nil { 1426 return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input) 1427 } 1428 return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input) 1429 } 1430 1431 // SubmitTransaction is a helper function that submits tx to txPool and logs a message. 1432 func SubmitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) { 1433 if err := b.SendTx(ctx, tx); err != nil { 1434 return common.Hash{}, err 1435 } 1436 if tx.To() == nil { 1437 signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number()) 1438 from, err := types.Sender(signer, tx) 1439 if err != nil { 1440 return common.Hash{}, err 1441 } 1442 addr := crypto.CreateAddress(from, tx.Nonce()) 1443 log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex()) 1444 } else { 1445 log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To()) 1446 } 1447 return tx.Hash(), nil 1448 } 1449 1450 // SendTransaction creates a transaction for the given argument, sign it and submit it to the 1451 // transaction pool. 1452 func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args SendTxArgs) (common.Hash, error) { 1453 // Look up the wallet containing the requested signer 1454 account := accounts.Account{Address: args.From} 1455 1456 wallet, err := s.b.AccountManager().Find(account) 1457 if err != nil { 1458 return common.Hash{}, err 1459 } 1460 1461 if args.Nonce == nil { 1462 // Hold the addresse's mutex around signing to prevent concurrent assignment of 1463 // the same nonce to multiple accounts. 1464 s.nonceLock.LockAddr(args.From) 1465 defer s.nonceLock.UnlockAddr(args.From) 1466 } 1467 1468 // Set some sanity defaults and terminate on failure 1469 if err := args.setDefaults(ctx, s.b); err != nil { 1470 return common.Hash{}, err 1471 } 1472 // Assemble the transaction and sign with the wallet 1473 tx := args.toTransaction() 1474 1475 signed, err := wallet.SignTx(account, tx, s.b.ChainConfig().ChainID) 1476 if err != nil { 1477 return common.Hash{}, err 1478 } 1479 return SubmitTransaction(ctx, s.b, signed) 1480 } 1481 1482 // FillTransaction fills the defaults (nonce, gas, gasPrice) on a given unsigned transaction, 1483 // and returns it to the caller for further processing (signing + broadcast) 1484 func (s *PublicTransactionPoolAPI) FillTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) { 1485 // Set some sanity defaults and terminate on failure 1486 if err := args.setDefaults(ctx, s.b); err != nil { 1487 return nil, err 1488 } 1489 // Assemble the transaction and obtain rlp 1490 tx := args.toTransaction() 1491 data, err := rlp.EncodeToBytes(tx) 1492 if err != nil { 1493 return nil, err 1494 } 1495 return &SignTransactionResult{data, tx}, nil 1496 } 1497 1498 // SendRawTransaction will add the signed transaction to the transaction pool. 1499 // The sender is responsible for signing the transaction and using the correct nonce. 1500 func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) { 1501 tx := new(types.Transaction) 1502 if err := rlp.DecodeBytes(encodedTx, tx); err != nil { 1503 return common.Hash{}, err 1504 } 1505 return SubmitTransaction(ctx, s.b, tx) 1506 } 1507 1508 // Sign calculates an ECDSA signature for: 1509 // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message). 1510 // 1511 // Note, the produced signature conforms to the secp256k1 curve R, S and V values, 1512 // where the V value will be 27 or 28 for legacy reasons. 1513 // 1514 // The account associated with addr must be unlocked. 1515 // 1516 // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign 1517 func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) { 1518 // Look up the wallet containing the requested signer 1519 account := accounts.Account{Address: addr} 1520 1521 wallet, err := s.b.AccountManager().Find(account) 1522 if err != nil { 1523 return nil, err 1524 } 1525 // Sign the requested hash with the wallet 1526 signature, err := wallet.SignText(account, data) 1527 if err == nil { 1528 signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper 1529 } 1530 return signature, err 1531 } 1532 1533 // SignTransactionResult represents a RLP encoded signed transaction. 1534 type SignTransactionResult struct { 1535 Raw hexutil.Bytes `json:"raw"` 1536 Tx *types.Transaction `json:"tx"` 1537 } 1538 1539 // SignTransaction will sign the given transaction with the from account. 1540 // The node needs to have the private key of the account corresponding with 1541 // the given from address and it needs to be unlocked. 1542 func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) { 1543 if args.Gas == nil { 1544 return nil, fmt.Errorf("gas not specified") 1545 } 1546 if args.GasPrice == nil { 1547 return nil, fmt.Errorf("gasPrice not specified") 1548 } 1549 if args.Nonce == nil { 1550 return nil, fmt.Errorf("nonce not specified") 1551 } 1552 if err := args.setDefaults(ctx, s.b); err != nil { 1553 return nil, err 1554 } 1555 tx, err := s.sign(args.From, args.toTransaction()) 1556 if err != nil { 1557 return nil, err 1558 } 1559 data, err := rlp.EncodeToBytes(tx) 1560 if err != nil { 1561 return nil, err 1562 } 1563 return &SignTransactionResult{data, tx}, nil 1564 } 1565 1566 // PendingTransactions returns the transactions that are in the transaction pool 1567 // and have a from address that is one of the accounts this node manages. 1568 func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) { 1569 pending, err := s.b.GetPoolTransactions() 1570 if err != nil { 1571 return nil, err 1572 } 1573 accounts := make(map[common.Address]struct{}) 1574 for _, wallet := range s.b.AccountManager().Wallets() { 1575 for _, account := range wallet.Accounts() { 1576 accounts[account.Address] = struct{}{} 1577 } 1578 } 1579 transactions := make([]*RPCTransaction, 0, len(pending)) 1580 for _, tx := range pending { 1581 var signer types.Signer = types.HomesteadSigner{} 1582 if tx.Protected() { 1583 signer = types.NewEIP155Signer(tx.ChainId()) 1584 } 1585 from, _ := types.Sender(signer, tx) 1586 if _, exists := accounts[from]; exists { 1587 transactions = append(transactions, newRPCPendingTransaction(tx)) 1588 } 1589 } 1590 return transactions, nil 1591 } 1592 1593 // Resend accepts an existing transaction and a new gas price and limit. It will remove 1594 // the given transaction from the pool and reinsert it with the new gas price and limit. 1595 func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) { 1596 if sendArgs.Nonce == nil { 1597 return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec") 1598 } 1599 if err := sendArgs.setDefaults(ctx, s.b); err != nil { 1600 return common.Hash{}, err 1601 } 1602 matchTx := sendArgs.toTransaction() 1603 pending, err := s.b.GetPoolTransactions() 1604 if err != nil { 1605 return common.Hash{}, err 1606 } 1607 1608 for _, p := range pending { 1609 var signer types.Signer = types.HomesteadSigner{} 1610 if p.Protected() { 1611 signer = types.NewEIP155Signer(p.ChainId()) 1612 } 1613 wantSigHash := signer.Hash(matchTx) 1614 1615 if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash { 1616 // Match. Re-sign and send the transaction. 1617 if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 { 1618 sendArgs.GasPrice = gasPrice 1619 } 1620 if gasLimit != nil && *gasLimit != 0 { 1621 sendArgs.Gas = gasLimit 1622 } 1623 signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction()) 1624 if err != nil { 1625 return common.Hash{}, err 1626 } 1627 if err = s.b.SendTx(ctx, signedTx); err != nil { 1628 return common.Hash{}, err 1629 } 1630 return signedTx.Hash(), nil 1631 } 1632 } 1633 1634 return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash()) 1635 } 1636 1637 // PublicDebugAPI is the collection of Ethereum APIs exposed over the public 1638 // debugging endpoint. 1639 type PublicDebugAPI struct { 1640 b Backend 1641 } 1642 1643 // NewPublicDebugAPI creates a new API definition for the public debug methods 1644 // of the Ethereum service. 1645 func NewPublicDebugAPI(b Backend) *PublicDebugAPI { 1646 return &PublicDebugAPI{b: b} 1647 } 1648 1649 // GetBlockRlp retrieves the RLP encoded for of a single block. 1650 func (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) { 1651 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1652 if block == nil { 1653 return "", fmt.Errorf("block #%d not found", number) 1654 } 1655 encoded, err := rlp.EncodeToBytes(block) 1656 if err != nil { 1657 return "", err 1658 } 1659 return fmt.Sprintf("%x", encoded), nil 1660 } 1661 1662 // TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the 1663 // given address, returning the address of the recovered signature 1664 // 1665 // This is a temporary method to debug the externalsigner integration, 1666 // TODO: Remove this method when the integration is mature 1667 func (api *PublicDebugAPI) TestSignCliqueBlock(ctx context.Context, address common.Address, number uint64) (common.Address, error) { 1668 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1669 if block == nil { 1670 return common.Address{}, fmt.Errorf("block #%d not found", number) 1671 } 1672 header := block.Header() 1673 header.Extra = make([]byte, 32+65) 1674 encoded := clique.CliqueRLP(header) 1675 1676 // Look up the wallet containing the requested signer 1677 account := accounts.Account{Address: address} 1678 wallet, err := api.b.AccountManager().Find(account) 1679 if err != nil { 1680 return common.Address{}, err 1681 } 1682 1683 signature, err := wallet.SignData(account, accounts.MimetypeClique, encoded) 1684 if err != nil { 1685 return common.Address{}, err 1686 } 1687 sealHash := clique.SealHash(header).Bytes() 1688 log.Info("test signing of clique block", 1689 "Sealhash", fmt.Sprintf("%x", sealHash), 1690 "signature", fmt.Sprintf("%x", signature)) 1691 pubkey, err := crypto.Ecrecover(sealHash, signature) 1692 if err != nil { 1693 return common.Address{}, err 1694 } 1695 var signer common.Address 1696 copy(signer[:], crypto.Keccak256(pubkey[1:])[12:]) 1697 1698 return signer, nil 1699 } 1700 1701 // PrintBlock retrieves a block and returns its pretty printed form. 1702 func (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) { 1703 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1704 if block == nil { 1705 return "", fmt.Errorf("block #%d not found", number) 1706 } 1707 return spew.Sdump(block), nil 1708 } 1709 1710 // SeedHash retrieves the seed hash of a block. 1711 func (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) { 1712 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1713 if block == nil { 1714 return "", fmt.Errorf("block #%d not found", number) 1715 } 1716 return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil 1717 } 1718 1719 // PrivateDebugAPI is the collection of Ethereum APIs exposed over the private 1720 // debugging endpoint. 1721 type PrivateDebugAPI struct { 1722 b Backend 1723 } 1724 1725 // NewPrivateDebugAPI creates a new API definition for the private debug methods 1726 // of the Ethereum service. 1727 func NewPrivateDebugAPI(b Backend) *PrivateDebugAPI { 1728 return &PrivateDebugAPI{b: b} 1729 } 1730 1731 // ChaindbProperty returns leveldb properties of the key-value database. 1732 func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) { 1733 if property == "" { 1734 property = "leveldb.stats" 1735 } else if !strings.HasPrefix(property, "leveldb.") { 1736 property = "leveldb." + property 1737 } 1738 return api.b.ChainDb().Stat(property) 1739 } 1740 1741 // ChaindbCompact flattens the entire key-value database into a single level, 1742 // removing all unused slots and merging all keys. 1743 func (api *PrivateDebugAPI) ChaindbCompact() error { 1744 for b := byte(0); b < 255; b++ { 1745 log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1)) 1746 if err := api.b.ChainDb().Compact([]byte{b}, []byte{b + 1}); err != nil { 1747 log.Error("Database compaction failed", "err", err) 1748 return err 1749 } 1750 } 1751 return nil 1752 } 1753 1754 // SetHead rewinds the head of the blockchain to a previous block. 1755 func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) { 1756 api.b.SetHead(uint64(number)) 1757 } 1758 1759 // PublicNetAPI offers network related RPC methods 1760 type PublicNetAPI struct { 1761 net *p2p.Server 1762 networkVersion uint64 1763 } 1764 1765 // NewPublicNetAPI creates a new net API instance. 1766 func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI { 1767 return &PublicNetAPI{net, networkVersion} 1768 } 1769 1770 // Listening returns an indication if the node is listening for network connections. 1771 func (s *PublicNetAPI) Listening() bool { 1772 return true // always listening 1773 } 1774 1775 // PeerCount returns the number of connected peers 1776 func (s *PublicNetAPI) PeerCount() hexutil.Uint { 1777 return hexutil.Uint(s.net.PeerCount()) 1778 } 1779 1780 // Version returns the current ethereum protocol version. 1781 func (s *PublicNetAPI) Version() string { 1782 return fmt.Sprintf("%d", s.networkVersion) 1783 }