github.com/Evanesco-Labs/go-evanesco@v1.0.1/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 "context" 21 "errors" 22 "fmt" 23 "math/big" 24 "strings" 25 "time" 26 27 "github.com/davecgh/go-spew/spew" 28 "github.com/Evanesco-Labs/go-evanesco/accounts" 29 "github.com/Evanesco-Labs/go-evanesco/accounts/abi" 30 "github.com/Evanesco-Labs/go-evanesco/accounts/keystore" 31 "github.com/Evanesco-Labs/go-evanesco/accounts/scwallet" 32 "github.com/Evanesco-Labs/go-evanesco/common" 33 "github.com/Evanesco-Labs/go-evanesco/common/hexutil" 34 "github.com/Evanesco-Labs/go-evanesco/common/math" 35 "github.com/Evanesco-Labs/go-evanesco/consensus/clique" 36 "github.com/Evanesco-Labs/go-evanesco/consensus/ethash" 37 "github.com/Evanesco-Labs/go-evanesco/consensus/misc" 38 "github.com/Evanesco-Labs/go-evanesco/core" 39 "github.com/Evanesco-Labs/go-evanesco/core/state" 40 "github.com/Evanesco-Labs/go-evanesco/core/types" 41 "github.com/Evanesco-Labs/go-evanesco/core/vm" 42 "github.com/Evanesco-Labs/go-evanesco/crypto" 43 "github.com/Evanesco-Labs/go-evanesco/log" 44 "github.com/Evanesco-Labs/go-evanesco/p2p" 45 "github.com/Evanesco-Labs/go-evanesco/params" 46 "github.com/Evanesco-Labs/go-evanesco/rlp" 47 "github.com/Evanesco-Labs/go-evanesco/rpc" 48 "github.com/tyler-smith/go-bip39" 49 ) 50 51 // PublicEthereumAPI provides an API to access Ethereum related information. 52 // It offers only methods that operate on public data that is freely available to anyone. 53 type PublicEthereumAPI struct { 54 b Backend 55 } 56 57 // NewPublicEthereumAPI creates a new Ethereum protocol API. 58 func NewPublicEthereumAPI(b Backend) *PublicEthereumAPI { 59 return &PublicEthereumAPI{b} 60 } 61 62 // GasPrice returns a suggestion for a gas price for legacy transactions. 63 func (s *PublicEthereumAPI) GasPrice(ctx context.Context) (*hexutil.Big, error) { 64 tipcap, err := s.b.SuggestGasTipCap(ctx) 65 if err != nil { 66 return nil, err 67 } 68 if head := s.b.CurrentHeader(); head.BaseFee != nil { 69 tipcap.Add(tipcap, head.BaseFee) 70 } 71 return (*hexutil.Big)(tipcap), err 72 } 73 74 // MaxPriorityFeePerGas returns a suggestion for a gas tip cap for dynamic fee transactions. 75 func (s *PublicEthereumAPI) MaxPriorityFeePerGas(ctx context.Context) (*hexutil.Big, error) { 76 tipcap, err := s.b.SuggestGasTipCap(ctx) 77 if err != nil { 78 return nil, err 79 } 80 return (*hexutil.Big)(tipcap), err 81 } 82 83 type feeHistoryResults struct { 84 FirstBlock rpc.BlockNumber 85 Reward [][]*hexutil.Big 86 BaseFee []*hexutil.Big 87 GasUsedRatio []float64 88 } 89 90 func (s *PublicEthereumAPI) FeeHistory(ctx context.Context, blockCount int, lastBlock rpc.BlockNumber, rewardPercentiles []float64) (feeHistoryResults, error) { 91 firstBlock, reward, baseFee, gasUsedRatio, err := s.b.FeeHistory(ctx, blockCount, lastBlock, rewardPercentiles) 92 if err != nil { 93 return feeHistoryResults{}, err 94 } 95 results := feeHistoryResults{ 96 FirstBlock: firstBlock, 97 GasUsedRatio: gasUsedRatio, 98 } 99 if reward != nil { 100 results.Reward = make([][]*hexutil.Big, len(reward)) 101 for j, w := range reward { 102 results.Reward[j] = make([]*hexutil.Big, len(w)) 103 for i, v := range w { 104 results.Reward[j][i] = (*hexutil.Big)(v) 105 } 106 } 107 } 108 if baseFee != nil { 109 results.BaseFee = make([]*hexutil.Big, len(baseFee)) 110 for i, v := range baseFee { 111 results.BaseFee[i] = (*hexutil.Big)(v) 112 } 113 } 114 return results, nil 115 } 116 117 // Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not 118 // yet received the latest block headers from its pears. In case it is synchronizing: 119 // - startingBlock: block number this node started to synchronise from 120 // - currentBlock: block number this node is currently importing 121 // - highestBlock: block number of the highest block header this node has received from peers 122 // - pulledStates: number of state entries processed until now 123 // - knownStates: number of known state entries that still need to be pulled 124 func (s *PublicEthereumAPI) Syncing() (interface{}, error) { 125 progress := s.b.Downloader().Progress() 126 127 // Return not syncing if the synchronisation already completed 128 if progress.CurrentBlock >= progress.HighestBlock { 129 return false, nil 130 } 131 // Otherwise gather the block sync stats 132 return map[string]interface{}{ 133 "startingBlock": hexutil.Uint64(progress.StartingBlock), 134 "currentBlock": hexutil.Uint64(progress.CurrentBlock), 135 "highestBlock": hexutil.Uint64(progress.HighestBlock), 136 "pulledStates": hexutil.Uint64(progress.PulledStates), 137 "knownStates": hexutil.Uint64(progress.KnownStates), 138 }, nil 139 } 140 141 // PublicTxPoolAPI offers and API for the transaction pool. It only operates on data that is non confidential. 142 type PublicTxPoolAPI struct { 143 b Backend 144 } 145 146 // NewPublicTxPoolAPI creates a new tx pool service that gives information about the transaction pool. 147 func NewPublicTxPoolAPI(b Backend) *PublicTxPoolAPI { 148 return &PublicTxPoolAPI{b} 149 } 150 151 // Content returns the transactions contained within the transaction pool. 152 func (s *PublicTxPoolAPI) Content() map[string]map[string]map[string]*RPCTransaction { 153 content := map[string]map[string]map[string]*RPCTransaction{ 154 "pending": make(map[string]map[string]*RPCTransaction), 155 "queued": make(map[string]map[string]*RPCTransaction), 156 } 157 pending, queue := s.b.TxPoolContent() 158 curHeader := s.b.CurrentHeader() 159 // Flatten the pending transactions 160 for account, txs := range pending { 161 dump := make(map[string]*RPCTransaction) 162 for _, tx := range txs { 163 dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx, curHeader, s.b.ChainConfig()) 164 } 165 content["pending"][account.Hex()] = dump 166 } 167 // Flatten the queued transactions 168 for account, txs := range queue { 169 dump := make(map[string]*RPCTransaction) 170 for _, tx := range txs { 171 dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx, curHeader, s.b.ChainConfig()) 172 } 173 content["queued"][account.Hex()] = dump 174 } 175 return content 176 } 177 178 // Status returns the number of pending and queued transaction in the pool. 179 func (s *PublicTxPoolAPI) Status() map[string]hexutil.Uint { 180 pending, queue := s.b.Stats() 181 return map[string]hexutil.Uint{ 182 "pending": hexutil.Uint(pending), 183 "queued": hexutil.Uint(queue), 184 } 185 } 186 187 // Inspect retrieves the content of the transaction pool and flattens it into an 188 // easily inspectable list. 189 func (s *PublicTxPoolAPI) Inspect() map[string]map[string]map[string]string { 190 content := map[string]map[string]map[string]string{ 191 "pending": make(map[string]map[string]string), 192 "queued": make(map[string]map[string]string), 193 } 194 pending, queue := s.b.TxPoolContent() 195 196 // Define a formatter to flatten a transaction into a string 197 var format = func(tx *types.Transaction) string { 198 if to := tx.To(); to != nil { 199 return fmt.Sprintf("%s: %v wei + %v gas × %v wei", tx.To().Hex(), tx.Value(), tx.Gas(), tx.GasPrice()) 200 } 201 return fmt.Sprintf("contract creation: %v wei + %v gas × %v wei", tx.Value(), tx.Gas(), tx.GasPrice()) 202 } 203 // Flatten the pending transactions 204 for account, txs := range pending { 205 dump := make(map[string]string) 206 for _, tx := range txs { 207 dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx) 208 } 209 content["pending"][account.Hex()] = dump 210 } 211 // Flatten the queued transactions 212 for account, txs := range queue { 213 dump := make(map[string]string) 214 for _, tx := range txs { 215 dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx) 216 } 217 content["queued"][account.Hex()] = dump 218 } 219 return content 220 } 221 222 // PublicAccountAPI provides an API to access accounts managed by this node. 223 // It offers only methods that can retrieve accounts. 224 type PublicAccountAPI struct { 225 am *accounts.Manager 226 } 227 228 // NewPublicAccountAPI creates a new PublicAccountAPI. 229 func NewPublicAccountAPI(am *accounts.Manager) *PublicAccountAPI { 230 return &PublicAccountAPI{am: am} 231 } 232 233 // Accounts returns the collection of accounts this node manages 234 func (s *PublicAccountAPI) Accounts() []common.Address { 235 return s.am.Accounts() 236 } 237 238 // PrivateAccountAPI provides an API to access accounts managed by this node. 239 // It offers methods to create, (un)lock en list accounts. Some methods accept 240 // passwords and are therefore considered private by default. 241 type PrivateAccountAPI struct { 242 am *accounts.Manager 243 nonceLock *AddrLocker 244 b Backend 245 } 246 247 // NewPrivateAccountAPI create a new PrivateAccountAPI. 248 func NewPrivateAccountAPI(b Backend, nonceLock *AddrLocker) *PrivateAccountAPI { 249 return &PrivateAccountAPI{ 250 am: b.AccountManager(), 251 nonceLock: nonceLock, 252 b: b, 253 } 254 } 255 256 // listAccounts will return a list of addresses for accounts this node manages. 257 func (s *PrivateAccountAPI) ListAccounts() []common.Address { 258 return s.am.Accounts() 259 } 260 261 // rawWallet is a JSON representation of an accounts.Wallet interface, with its 262 // data contents extracted into plain fields. 263 type rawWallet struct { 264 URL string `json:"url"` 265 Status string `json:"status"` 266 Failure string `json:"failure,omitempty"` 267 Accounts []accounts.Account `json:"accounts,omitempty"` 268 } 269 270 // ListWallets will return a list of wallets this node manages. 271 func (s *PrivateAccountAPI) ListWallets() []rawWallet { 272 wallets := make([]rawWallet, 0) // return [] instead of nil if empty 273 for _, wallet := range s.am.Wallets() { 274 status, failure := wallet.Status() 275 276 raw := rawWallet{ 277 URL: wallet.URL().String(), 278 Status: status, 279 Accounts: wallet.Accounts(), 280 } 281 if failure != nil { 282 raw.Failure = failure.Error() 283 } 284 wallets = append(wallets, raw) 285 } 286 return wallets 287 } 288 289 // OpenWallet initiates a hardware wallet opening procedure, establishing a USB 290 // connection and attempting to authenticate via the provided passphrase. Note, 291 // the method may return an extra challenge requiring a second open (e.g. the 292 // Trezor PIN matrix challenge). 293 func (s *PrivateAccountAPI) OpenWallet(url string, passphrase *string) error { 294 wallet, err := s.am.Wallet(url) 295 if err != nil { 296 return err 297 } 298 pass := "" 299 if passphrase != nil { 300 pass = *passphrase 301 } 302 return wallet.Open(pass) 303 } 304 305 // DeriveAccount requests a HD wallet to derive a new account, optionally pinning 306 // it for later reuse. 307 func (s *PrivateAccountAPI) DeriveAccount(url string, path string, pin *bool) (accounts.Account, error) { 308 wallet, err := s.am.Wallet(url) 309 if err != nil { 310 return accounts.Account{}, err 311 } 312 derivPath, err := accounts.ParseDerivationPath(path) 313 if err != nil { 314 return accounts.Account{}, err 315 } 316 if pin == nil { 317 pin = new(bool) 318 } 319 return wallet.Derive(derivPath, *pin) 320 } 321 322 // NewAccount will create a new account and returns the address for the new account. 323 func (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) { 324 ks, err := fetchKeystore(s.am) 325 if err != nil { 326 return common.Address{}, err 327 } 328 acc, err := ks.NewAccount(password) 329 if err == nil { 330 log.Info("Your new key was generated", "address", acc.Address) 331 log.Warn("Please backup your key file!", "path", acc.URL.Path) 332 log.Warn("Please remember your password!") 333 return acc.Address, nil 334 } 335 return common.Address{}, err 336 } 337 338 // fetchKeystore retrieves the encrypted keystore from the account manager. 339 func fetchKeystore(am *accounts.Manager) (*keystore.KeyStore, error) { 340 if ks := am.Backends(keystore.KeyStoreType); len(ks) > 0 { 341 return ks[0].(*keystore.KeyStore), nil 342 } 343 return nil, errors.New("local keystore not used") 344 } 345 346 // ImportRawKey stores the given hex encoded ECDSA key into the key directory, 347 // encrypting it with the passphrase. 348 func (s *PrivateAccountAPI) ImportRawKey(privkey string, password string) (common.Address, error) { 349 key, err := crypto.HexToECDSA(privkey) 350 if err != nil { 351 return common.Address{}, err 352 } 353 ks, err := fetchKeystore(s.am) 354 if err != nil { 355 return common.Address{}, err 356 } 357 acc, err := ks.ImportECDSA(key, password) 358 return acc.Address, err 359 } 360 361 // UnlockAccount will unlock the account associated with the given address with 362 // the given password for duration seconds. If duration is nil it will use a 363 // default of 300 seconds. It returns an indication if the account was unlocked. 364 func (s *PrivateAccountAPI) UnlockAccount(ctx context.Context, addr common.Address, password string, duration *uint64) (bool, error) { 365 // When the API is exposed by external RPC(http, ws etc), unless the user 366 // explicitly specifies to allow the insecure account unlocking, otherwise 367 // it is disabled. 368 if s.b.ExtRPCEnabled() && !s.b.AccountManager().Config().InsecureUnlockAllowed { 369 return false, errors.New("account unlock with HTTP access is forbidden") 370 } 371 372 const max = uint64(time.Duration(math.MaxInt64) / time.Second) 373 var d time.Duration 374 if duration == nil { 375 d = 300 * time.Second 376 } else if *duration > max { 377 return false, errors.New("unlock duration too large") 378 } else { 379 d = time.Duration(*duration) * time.Second 380 } 381 ks, err := fetchKeystore(s.am) 382 if err != nil { 383 return false, err 384 } 385 err = ks.TimedUnlock(accounts.Account{Address: addr}, password, d) 386 if err != nil { 387 log.Warn("Failed account unlock attempt", "address", addr, "err", err) 388 } 389 return err == nil, err 390 } 391 392 // LockAccount will lock the account associated with the given address when it's unlocked. 393 func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool { 394 if ks, err := fetchKeystore(s.am); err == nil { 395 return ks.Lock(addr) == nil 396 } 397 return false 398 } 399 400 // signTransaction sets defaults and signs the given transaction 401 // NOTE: the caller needs to ensure that the nonceLock is held, if applicable, 402 // and release it after the transaction has been submitted to the tx pool 403 func (s *PrivateAccountAPI) signTransaction(ctx context.Context, args *TransactionArgs, passwd string) (*types.Transaction, error) { 404 // Look up the wallet containing the requested signer 405 account := accounts.Account{Address: args.from()} 406 wallet, err := s.am.Find(account) 407 if err != nil { 408 return nil, err 409 } 410 // Set some sanity defaults and terminate on failure 411 if err := args.setDefaults(ctx, s.b); err != nil { 412 return nil, err 413 } 414 // Assemble the transaction and sign with the wallet 415 tx := args.toTransaction() 416 417 return wallet.SignTxWithPassphrase(account, passwd, tx, s.b.ChainConfig().ChainID) 418 } 419 420 // SendTransaction will create a transaction from the given arguments and 421 // tries to sign it with the key associated with args.From. If the given 422 // passwd isn't able to decrypt the key it fails. 423 func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args TransactionArgs, passwd string) (common.Hash, error) { 424 if args.Nonce == nil { 425 // Hold the addresse's mutex around signing to prevent concurrent assignment of 426 // the same nonce to multiple accounts. 427 s.nonceLock.LockAddr(args.from()) 428 defer s.nonceLock.UnlockAddr(args.from()) 429 } 430 signed, err := s.signTransaction(ctx, &args, passwd) 431 if err != nil { 432 log.Warn("Failed transaction send attempt", "from", args.from(), "to", args.To, "value", args.Value.ToInt(), "err", err) 433 return common.Hash{}, err 434 } 435 return SubmitTransaction(ctx, s.b, signed) 436 } 437 438 // SignTransaction will create a transaction from the given arguments and 439 // tries to sign it with the key associated with args.From. If the given passwd isn't 440 // able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast 441 // to other nodes 442 func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args TransactionArgs, passwd string) (*SignTransactionResult, error) { 443 // No need to obtain the noncelock mutex, since we won't be sending this 444 // tx into the transaction pool, but right back to the user 445 if args.From == nil { 446 return nil, fmt.Errorf("sender not specified") 447 } 448 if args.Gas == nil { 449 return nil, fmt.Errorf("gas not specified") 450 } 451 if args.GasPrice == nil { 452 return nil, fmt.Errorf("gasPrice not specified") 453 } 454 if args.Nonce == nil { 455 return nil, fmt.Errorf("nonce not specified") 456 } 457 // Before actually sign the transaction, ensure the transaction fee is reasonable. 458 if err := checkTxFee(args.GasPrice.ToInt(), uint64(*args.Gas), s.b.RPCTxFeeCap()); err != nil { 459 return nil, err 460 } 461 signed, err := s.signTransaction(ctx, &args, passwd) 462 if err != nil { 463 log.Warn("Failed transaction sign attempt", "from", args.from(), "to", args.To, "value", args.Value.ToInt(), "err", err) 464 return nil, err 465 } 466 data, err := signed.MarshalBinary() 467 if err != nil { 468 return nil, err 469 } 470 return &SignTransactionResult{data, signed}, nil 471 } 472 473 // Sign calculates an Ethereum ECDSA signature for: 474 // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message)) 475 // 476 // Note, the produced signature conforms to the secp256k1 curve R, S and V values, 477 // where the V value will be 27 or 28 for legacy reasons. 478 // 479 // The key used to calculate the signature is decrypted with the given password. 480 // 481 // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign 482 func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) { 483 // Look up the wallet containing the requested signer 484 account := accounts.Account{Address: addr} 485 486 wallet, err := s.b.AccountManager().Find(account) 487 if err != nil { 488 return nil, err 489 } 490 // Assemble sign the data with the wallet 491 signature, err := wallet.SignTextWithPassphrase(account, passwd, data) 492 if err != nil { 493 log.Warn("Failed data sign attempt", "address", addr, "err", err) 494 return nil, err 495 } 496 signature[crypto.RecoveryIDOffset] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper 497 return signature, nil 498 } 499 500 // EcRecover returns the address for the account that was used to create the signature. 501 // Note, this function is compatible with eth_sign and personal_sign. As such it recovers 502 // the address of: 503 // hash = keccak256("\x19Ethereum Signed Message:\n"${message length}${message}) 504 // addr = ecrecover(hash, signature) 505 // 506 // Note, the signature must conform to the secp256k1 curve R, S and V values, where 507 // the V value must be 27 or 28 for legacy reasons. 508 // 509 // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover 510 func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) { 511 if len(sig) != crypto.SignatureLength { 512 return common.Address{}, fmt.Errorf("signature must be %d bytes long", crypto.SignatureLength) 513 } 514 if sig[crypto.RecoveryIDOffset] != 27 && sig[crypto.RecoveryIDOffset] != 28 { 515 return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)") 516 } 517 sig[crypto.RecoveryIDOffset] -= 27 // Transform yellow paper V from 27/28 to 0/1 518 519 rpk, err := crypto.SigToPub(accounts.TextHash(data), sig) 520 if err != nil { 521 return common.Address{}, err 522 } 523 return crypto.PubkeyToAddress(*rpk), nil 524 } 525 526 // SignAndSendTransaction was renamed to SendTransaction. This method is deprecated 527 // and will be removed in the future. It primary goal is to give clients time to update. 528 func (s *PrivateAccountAPI) SignAndSendTransaction(ctx context.Context, args TransactionArgs, passwd string) (common.Hash, error) { 529 return s.SendTransaction(ctx, args, passwd) 530 } 531 532 // InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key. 533 func (s *PrivateAccountAPI) InitializeWallet(ctx context.Context, url string) (string, error) { 534 wallet, err := s.am.Wallet(url) 535 if err != nil { 536 return "", err 537 } 538 539 entropy, err := bip39.NewEntropy(256) 540 if err != nil { 541 return "", err 542 } 543 544 mnemonic, err := bip39.NewMnemonic(entropy) 545 if err != nil { 546 return "", err 547 } 548 549 seed := bip39.NewSeed(mnemonic, "") 550 551 switch wallet := wallet.(type) { 552 case *scwallet.Wallet: 553 return mnemonic, wallet.Initialize(seed) 554 default: 555 return "", fmt.Errorf("specified wallet does not support initialization") 556 } 557 } 558 559 // Unpair deletes a pairing between wallet and geth. 560 func (s *PrivateAccountAPI) Unpair(ctx context.Context, url string, pin string) error { 561 wallet, err := s.am.Wallet(url) 562 if err != nil { 563 return err 564 } 565 566 switch wallet := wallet.(type) { 567 case *scwallet.Wallet: 568 return wallet.Unpair([]byte(pin)) 569 default: 570 return fmt.Errorf("specified wallet does not support pairing") 571 } 572 } 573 574 // PublicBlockChainAPI provides an API to access the Ethereum blockchain. 575 // It offers only methods that operate on public data that is freely available to anyone. 576 type PublicBlockChainAPI struct { 577 b Backend 578 } 579 580 // NewPublicBlockChainAPI creates a new Ethereum blockchain API. 581 func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI { 582 return &PublicBlockChainAPI{b} 583 } 584 585 // ChainId is the EIP-155 replay-protection chain id for the current ethereum chain config. 586 func (api *PublicBlockChainAPI) ChainId() (*hexutil.Big, error) { 587 // if current block is at or past the EIP-155 replay-protection fork block, return chainID from config 588 if config := api.b.ChainConfig(); config.IsEIP155(api.b.CurrentBlock().Number()) { 589 return (*hexutil.Big)(config.ChainID), nil 590 } 591 return nil, fmt.Errorf("chain not synced beyond EIP-155 replay-protection fork block") 592 } 593 594 // BlockNumber returns the block number of the chain head. 595 func (s *PublicBlockChainAPI) BlockNumber() hexutil.Uint64 { 596 header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available 597 return hexutil.Uint64(header.Number.Uint64()) 598 } 599 600 // GetBalance returns the amount of wei for the given address in the state of the 601 // given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta 602 // block numbers are also allowed. 603 func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (*hexutil.Big, error) { 604 state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash) 605 if state == nil || err != nil { 606 return nil, err 607 } 608 return (*hexutil.Big)(state.GetBalance(address)), state.Error() 609 } 610 611 // Result structs for GetProof 612 type AccountResult struct { 613 Address common.Address `json:"address"` 614 AccountProof []string `json:"accountProof"` 615 Balance *hexutil.Big `json:"balance"` 616 CodeHash common.Hash `json:"codeHash"` 617 Nonce hexutil.Uint64 `json:"nonce"` 618 StorageHash common.Hash `json:"storageHash"` 619 StorageProof []StorageResult `json:"storageProof"` 620 } 621 622 type StorageResult struct { 623 Key string `json:"key"` 624 Value *hexutil.Big `json:"value"` 625 Proof []string `json:"proof"` 626 } 627 628 // GetProof returns the Merkle-proof for a given account and optionally some storage keys. 629 func (s *PublicBlockChainAPI) GetProof(ctx context.Context, address common.Address, storageKeys []string, blockNrOrHash rpc.BlockNumberOrHash) (*AccountResult, error) { 630 state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash) 631 if state == nil || err != nil { 632 return nil, err 633 } 634 635 storageTrie := state.StorageTrie(address) 636 storageHash := types.EmptyRootHash 637 codeHash := state.GetCodeHash(address) 638 storageProof := make([]StorageResult, len(storageKeys)) 639 640 // if we have a storageTrie, (which means the account exists), we can update the storagehash 641 if storageTrie != nil { 642 storageHash = storageTrie.Hash() 643 } else { 644 // no storageTrie means the account does not exist, so the codeHash is the hash of an empty bytearray. 645 codeHash = crypto.Keccak256Hash(nil) 646 } 647 648 // create the proof for the storageKeys 649 for i, key := range storageKeys { 650 if storageTrie != nil { 651 proof, storageError := state.GetStorageProof(address, common.HexToHash(key)) 652 if storageError != nil { 653 return nil, storageError 654 } 655 storageProof[i] = StorageResult{key, (*hexutil.Big)(state.GetState(address, common.HexToHash(key)).Big()), toHexSlice(proof)} 656 } else { 657 storageProof[i] = StorageResult{key, &hexutil.Big{}, []string{}} 658 } 659 } 660 661 // create the accountProof 662 accountProof, proofErr := state.GetProof(address) 663 if proofErr != nil { 664 return nil, proofErr 665 } 666 667 return &AccountResult{ 668 Address: address, 669 AccountProof: toHexSlice(accountProof), 670 Balance: (*hexutil.Big)(state.GetBalance(address)), 671 CodeHash: codeHash, 672 Nonce: hexutil.Uint64(state.GetNonce(address)), 673 StorageHash: storageHash, 674 StorageProof: storageProof, 675 }, state.Error() 676 } 677 678 // GetHeaderByNumber returns the requested canonical block header. 679 // * When blockNr is -1 the chain head is returned. 680 // * When blockNr is -2 the pending chain head is returned. 681 func (s *PublicBlockChainAPI) GetHeaderByNumber(ctx context.Context, number rpc.BlockNumber) (map[string]interface{}, error) { 682 header, err := s.b.HeaderByNumber(ctx, number) 683 if header != nil && err == nil { 684 response := s.rpcMarshalHeader(ctx, header) 685 if number == rpc.PendingBlockNumber { 686 // Pending header need to nil out a few fields 687 for _, field := range []string{"hash", "nonce", "miner"} { 688 response[field] = nil 689 } 690 } 691 return response, err 692 } 693 return nil, err 694 } 695 696 // GetHeaderByHash returns the requested header by hash. 697 func (s *PublicBlockChainAPI) GetHeaderByHash(ctx context.Context, hash common.Hash) map[string]interface{} { 698 header, _ := s.b.HeaderByHash(ctx, hash) 699 if header != nil { 700 return s.rpcMarshalHeader(ctx, header) 701 } 702 return nil 703 } 704 705 // GetBlockByNumber returns the requested canonical block. 706 // * When blockNr is -1 the chain head is returned. 707 // * When blockNr is -2 the pending chain head is returned. 708 // * When fullTx is true all transactions in the block are returned, otherwise 709 // only the transaction hash is returned. 710 func (s *PublicBlockChainAPI) GetBlockByNumber(ctx context.Context, number rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) { 711 block, err := s.b.BlockByNumber(ctx, number) 712 if block != nil && err == nil { 713 response, err := s.rpcMarshalBlock(ctx, block, true, fullTx) 714 if err == nil && number == rpc.PendingBlockNumber { 715 // Pending blocks need to nil out a few fields 716 for _, field := range []string{"hash", "nonce", "miner"} { 717 response[field] = nil 718 } 719 } 720 return response, err 721 } 722 return nil, err 723 } 724 725 // GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full 726 // detail, otherwise only the transaction hash is returned. 727 func (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, hash common.Hash, fullTx bool) (map[string]interface{}, error) { 728 block, err := s.b.BlockByHash(ctx, hash) 729 if block != nil { 730 return s.rpcMarshalBlock(ctx, block, true, fullTx) 731 } 732 return nil, err 733 } 734 735 // GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true 736 // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 737 func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) { 738 block, err := s.b.BlockByNumber(ctx, blockNr) 739 if block != nil { 740 uncles := block.Uncles() 741 if index >= hexutil.Uint(len(uncles)) { 742 log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index) 743 return nil, nil 744 } 745 block = types.NewBlockWithHeader(uncles[index]) 746 return s.rpcMarshalBlock(ctx, block, false, false) 747 } 748 return nil, err 749 } 750 751 // GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true 752 // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned. 753 func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) { 754 block, err := s.b.BlockByHash(ctx, blockHash) 755 if block != nil { 756 uncles := block.Uncles() 757 if index >= hexutil.Uint(len(uncles)) { 758 log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index) 759 return nil, nil 760 } 761 block = types.NewBlockWithHeader(uncles[index]) 762 return s.rpcMarshalBlock(ctx, block, false, false) 763 } 764 return nil, err 765 } 766 767 // GetUncleCountByBlockNumber returns number of uncles in the block for the given block number 768 func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint { 769 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 770 n := hexutil.Uint(len(block.Uncles())) 771 return &n 772 } 773 return nil 774 } 775 776 // GetUncleCountByBlockHash returns number of uncles in the block for the given block hash 777 func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint { 778 if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil { 779 n := hexutil.Uint(len(block.Uncles())) 780 return &n 781 } 782 return nil 783 } 784 785 // GetCode returns the code stored at the given address in the state for the given block number. 786 func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (hexutil.Bytes, error) { 787 state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash) 788 if state == nil || err != nil { 789 return nil, err 790 } 791 code := state.GetCode(address) 792 return code, state.Error() 793 } 794 795 // GetStorageAt returns the storage from the state at the given address, key and 796 // block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block 797 // numbers are also allowed. 798 func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNrOrHash rpc.BlockNumberOrHash) (hexutil.Bytes, error) { 799 state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash) 800 if state == nil || err != nil { 801 return nil, err 802 } 803 res := state.GetState(address, common.HexToHash(key)) 804 return res[:], state.Error() 805 } 806 807 // OverrideAccount indicates the overriding fields of account during the execution 808 // of a message call. 809 // Note, state and stateDiff can't be specified at the same time. If state is 810 // set, message execution will only use the data in the given state. Otherwise 811 // if statDiff is set, all diff will be applied first and then execute the call 812 // message. 813 type OverrideAccount struct { 814 Nonce *hexutil.Uint64 `json:"nonce"` 815 Code *hexutil.Bytes `json:"code"` 816 Balance **hexutil.Big `json:"balance"` 817 State *map[common.Hash]common.Hash `json:"state"` 818 StateDiff *map[common.Hash]common.Hash `json:"stateDiff"` 819 } 820 821 // StateOverride is the collection of overridden accounts. 822 type StateOverride map[common.Address]OverrideAccount 823 824 // Apply overrides the fields of specified accounts into the given state. 825 func (diff *StateOverride) Apply(state *state.StateDB) error { 826 if diff == nil { 827 return nil 828 } 829 for addr, account := range *diff { 830 // Override account nonce. 831 if account.Nonce != nil { 832 state.SetNonce(addr, uint64(*account.Nonce)) 833 } 834 // Override account(contract) code. 835 if account.Code != nil { 836 state.SetCode(addr, *account.Code) 837 } 838 // Override account balance. 839 if account.Balance != nil { 840 state.SetBalance(addr, (*big.Int)(*account.Balance)) 841 } 842 if account.State != nil && account.StateDiff != nil { 843 return fmt.Errorf("account %s has both 'state' and 'stateDiff'", addr.Hex()) 844 } 845 // Replace entire state if caller requires. 846 if account.State != nil { 847 state.SetStorage(addr, *account.State) 848 } 849 // Apply state diff into specified accounts. 850 if account.StateDiff != nil { 851 for key, value := range *account.StateDiff { 852 state.SetState(addr, key, value) 853 } 854 } 855 } 856 return nil 857 } 858 859 func DoCall(ctx context.Context, b Backend, args TransactionArgs, blockNrOrHash rpc.BlockNumberOrHash, overrides *StateOverride, timeout time.Duration, globalGasCap uint64) (*core.ExecutionResult, error) { 860 defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now()) 861 862 state, header, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash) 863 if state == nil || err != nil { 864 return nil, err 865 } 866 if err := overrides.Apply(state); err != nil { 867 return nil, err 868 } 869 // Setup context so it may be cancelled the call has completed 870 // or, in case of unmetered gas, setup a context with a timeout. 871 var cancel context.CancelFunc 872 if timeout > 0 { 873 ctx, cancel = context.WithTimeout(ctx, timeout) 874 } else { 875 ctx, cancel = context.WithCancel(ctx) 876 } 877 // Make sure the context is cancelled when the call has completed 878 // this makes sure resources are cleaned up. 879 defer cancel() 880 881 // Get a new instance of the EVM. 882 msg, err := args.ToMessage(globalGasCap, header.BaseFee) 883 if err != nil { 884 return nil, err 885 } 886 evm, vmError, err := b.GetEVM(ctx, msg, state, header, &vm.Config{NoBaseFee: true}) 887 if err != nil { 888 return nil, err 889 } 890 // Wait for the context to be done and cancel the evm. Even if the 891 // EVM has finished, cancelling may be done (repeatedly) 892 go func() { 893 <-ctx.Done() 894 evm.Cancel() 895 }() 896 897 // Execute the message. 898 gp := new(core.GasPool).AddGas(math.MaxUint64) 899 result, err := core.ApplyMessage(evm, msg, gp) 900 if err := vmError(); err != nil { 901 return nil, err 902 } 903 904 // If the timer caused an abort, return an appropriate error message 905 if evm.Cancelled() { 906 return nil, fmt.Errorf("execution aborted (timeout = %v)", timeout) 907 } 908 if err != nil { 909 return result, fmt.Errorf("err: %w (supplied gas %d)", err, msg.Gas()) 910 } 911 return result, nil 912 } 913 914 func newRevertError(result *core.ExecutionResult) *revertError { 915 reason, errUnpack := abi.UnpackRevert(result.Revert()) 916 err := errors.New("execution reverted") 917 if errUnpack == nil { 918 err = fmt.Errorf("execution reverted: %v", reason) 919 } 920 return &revertError{ 921 error: err, 922 reason: hexutil.Encode(result.Revert()), 923 } 924 } 925 926 // revertError is an API error that encompassas an EVM revertal with JSON error 927 // code and a binary data blob. 928 type revertError struct { 929 error 930 reason string // revert reason hex encoded 931 } 932 933 // ErrorCode returns the JSON error code for a revertal. 934 // See: https://github.com/ethereum/wiki/wiki/JSON-RPC-Error-Codes-Improvement-Proposal 935 func (e *revertError) ErrorCode() int { 936 return 3 937 } 938 939 // ErrorData returns the hex encoded revert reason. 940 func (e *revertError) ErrorData() interface{} { 941 return e.reason 942 } 943 944 // Call executes the given transaction on the state for the given block number. 945 // 946 // Additionally, the caller can specify a batch of contract for fields overriding. 947 // 948 // Note, this function doesn't make and changes in the state/blockchain and is 949 // useful to execute and retrieve values. 950 func (s *PublicBlockChainAPI) Call(ctx context.Context, args TransactionArgs, blockNrOrHash rpc.BlockNumberOrHash, overrides *StateOverride) (hexutil.Bytes, error) { 951 result, err := DoCall(ctx, s.b, args, blockNrOrHash, overrides, 5*time.Second, s.b.RPCGasCap()) 952 if err != nil { 953 return nil, err 954 } 955 // If the result contains a revert reason, try to unpack and return it. 956 if len(result.Revert()) > 0 { 957 return nil, newRevertError(result) 958 } 959 return result.Return(), result.Err 960 } 961 962 func DoEstimateGas(ctx context.Context, b Backend, args TransactionArgs, blockNrOrHash rpc.BlockNumberOrHash, gasCap uint64) (hexutil.Uint64, error) { 963 // Binary search the gas requirement, as it may be higher than the amount used 964 var ( 965 lo uint64 = params.TxGas - 1 966 hi uint64 967 cap uint64 968 ) 969 // Use zero address if sender unspecified. 970 if args.From == nil { 971 args.From = new(common.Address) 972 } 973 // Determine the highest gas limit can be used during the estimation. 974 if args.Gas != nil && uint64(*args.Gas) >= params.TxGas { 975 hi = uint64(*args.Gas) 976 } else { 977 // Retrieve the block to act as the gas ceiling 978 block, err := b.BlockByNumberOrHash(ctx, blockNrOrHash) 979 if err != nil { 980 return 0, err 981 } 982 if block == nil { 983 return 0, errors.New("block not found") 984 } 985 hi = block.GasLimit() 986 } 987 // Recap the highest gas limit with account's available balance. 988 if args.GasPrice != nil && args.GasPrice.ToInt().BitLen() != 0 { 989 state, _, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash) 990 if err != nil { 991 return 0, err 992 } 993 balance := state.GetBalance(*args.From) // from can't be nil 994 available := new(big.Int).Set(balance) 995 if args.Value != nil { 996 if args.Value.ToInt().Cmp(available) >= 0 { 997 return 0, errors.New("insufficient funds for transfer") 998 } 999 available.Sub(available, args.Value.ToInt()) 1000 } 1001 allowance := new(big.Int).Div(available, args.GasPrice.ToInt()) 1002 1003 // If the allowance is larger than maximum uint64, skip checking 1004 if allowance.IsUint64() && hi > allowance.Uint64() { 1005 transfer := args.Value 1006 if transfer == nil { 1007 transfer = new(hexutil.Big) 1008 } 1009 log.Warn("Gas estimation capped by limited funds", "original", hi, "balance", balance, 1010 "sent", transfer.ToInt(), "gasprice", args.GasPrice.ToInt(), "fundable", allowance) 1011 hi = allowance.Uint64() 1012 } 1013 } 1014 // Recap the highest gas allowance with specified gascap. 1015 if gasCap != 0 && hi > gasCap { 1016 log.Warn("Caller gas above allowance, capping", "requested", hi, "cap", gasCap) 1017 hi = gasCap 1018 } 1019 cap = hi 1020 1021 // Create a helper to check if a gas allowance results in an executable transaction 1022 executable := func(gas uint64) (bool, *core.ExecutionResult, error) { 1023 args.Gas = (*hexutil.Uint64)(&gas) 1024 1025 result, err := DoCall(ctx, b, args, blockNrOrHash, nil, 0, gasCap) 1026 if err != nil { 1027 if errors.Is(err, core.ErrIntrinsicGas) { 1028 return true, nil, nil // Special case, raise gas limit 1029 } 1030 return true, nil, err // Bail out 1031 } 1032 return result.Failed(), result, nil 1033 } 1034 // Execute the binary search and hone in on an executable gas limit 1035 for lo+1 < hi { 1036 mid := (hi + lo) / 2 1037 failed, _, err := executable(mid) 1038 1039 // If the error is not nil(consensus error), it means the provided message 1040 // call or transaction will never be accepted no matter how much gas it is 1041 // assigned. Return the error directly, don't struggle any more. 1042 if err != nil { 1043 return 0, err 1044 } 1045 if failed { 1046 lo = mid 1047 } else { 1048 hi = mid 1049 } 1050 } 1051 // Reject the transaction as invalid if it still fails at the highest allowance 1052 if hi == cap { 1053 failed, result, err := executable(hi) 1054 if err != nil { 1055 return 0, err 1056 } 1057 if failed { 1058 if result != nil && result.Err != vm.ErrOutOfGas { 1059 if len(result.Revert()) > 0 { 1060 return 0, newRevertError(result) 1061 } 1062 return 0, result.Err 1063 } 1064 // Otherwise, the specified gas cap is too low 1065 return 0, fmt.Errorf("gas required exceeds allowance (%d)", cap) 1066 } 1067 } 1068 return hexutil.Uint64(hi), nil 1069 } 1070 1071 // EstimateGas returns an estimate of the amount of gas needed to execute the 1072 // given transaction against the current pending block. 1073 func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args TransactionArgs, blockNrOrHash *rpc.BlockNumberOrHash) (hexutil.Uint64, error) { 1074 bNrOrHash := rpc.BlockNumberOrHashWithNumber(rpc.PendingBlockNumber) 1075 if blockNrOrHash != nil { 1076 bNrOrHash = *blockNrOrHash 1077 } 1078 return DoEstimateGas(ctx, s.b, args, bNrOrHash, s.b.RPCGasCap()) 1079 } 1080 1081 // ExecutionResult groups all structured logs emitted by the EVM 1082 // while replaying a transaction in debug mode as well as transaction 1083 // execution status, the amount of gas used and the return value 1084 type ExecutionResult struct { 1085 Gas uint64 `json:"gas"` 1086 Failed bool `json:"failed"` 1087 ReturnValue string `json:"returnValue"` 1088 StructLogs []StructLogRes `json:"structLogs"` 1089 } 1090 1091 // StructLogRes stores a structured log emitted by the EVM while replaying a 1092 // transaction in debug mode 1093 type StructLogRes struct { 1094 Pc uint64 `json:"pc"` 1095 Op string `json:"op"` 1096 Gas uint64 `json:"gas"` 1097 GasCost uint64 `json:"gasCost"` 1098 Depth int `json:"depth"` 1099 Error error `json:"error,omitempty"` 1100 Stack *[]string `json:"stack,omitempty"` 1101 Memory *[]string `json:"memory,omitempty"` 1102 Storage *map[string]string `json:"storage,omitempty"` 1103 } 1104 1105 // FormatLogs formats EVM returned structured logs for json output 1106 func FormatLogs(logs []vm.StructLog) []StructLogRes { 1107 formatted := make([]StructLogRes, len(logs)) 1108 for index, trace := range logs { 1109 formatted[index] = StructLogRes{ 1110 Pc: trace.Pc, 1111 Op: trace.Op.String(), 1112 Gas: trace.Gas, 1113 GasCost: trace.GasCost, 1114 Depth: trace.Depth, 1115 Error: trace.Err, 1116 } 1117 if trace.Stack != nil { 1118 stack := make([]string, len(trace.Stack)) 1119 for i, stackValue := range trace.Stack { 1120 stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32)) 1121 } 1122 formatted[index].Stack = &stack 1123 } 1124 if trace.Memory != nil { 1125 memory := make([]string, 0, (len(trace.Memory)+31)/32) 1126 for i := 0; i+32 <= len(trace.Memory); i += 32 { 1127 memory = append(memory, fmt.Sprintf("%x", trace.Memory[i:i+32])) 1128 } 1129 formatted[index].Memory = &memory 1130 } 1131 if trace.Storage != nil { 1132 storage := make(map[string]string) 1133 for i, storageValue := range trace.Storage { 1134 storage[fmt.Sprintf("%x", i)] = fmt.Sprintf("%x", storageValue) 1135 } 1136 formatted[index].Storage = &storage 1137 } 1138 } 1139 return formatted 1140 } 1141 1142 // RPCMarshalHeader converts the given header to the RPC output . 1143 func RPCMarshalHeader(head *types.Header) map[string]interface{} { 1144 result := map[string]interface{}{ 1145 "number": (*hexutil.Big)(head.Number), 1146 "hash": head.Hash(), 1147 "parentHash": head.ParentHash, 1148 "nonce": head.Nonce, 1149 "mixHash": head.MixDigest, 1150 "sha3Uncles": head.UncleHash, 1151 "logsBloom": head.Bloom, 1152 "stateRoot": head.Root, 1153 "miner": head.Coinbase, 1154 "difficulty": (*hexutil.Big)(head.Difficulty), 1155 "extraData": hexutil.Bytes(head.Extra), 1156 "size": hexutil.Uint64(head.Size()), 1157 "gasLimit": hexutil.Uint64(head.GasLimit), 1158 "gasUsed": hexutil.Uint64(head.GasUsed), 1159 "timestamp": hexutil.Uint64(head.Time), 1160 "transactionsRoot": head.TxHash, 1161 "receiptsRoot": head.ReceiptHash, 1162 "best_lottery": head.BestLottery, 1163 } 1164 1165 if head.BaseFee != nil { 1166 result["baseFeePerGas"] = (*hexutil.Big)(head.BaseFee) 1167 } 1168 1169 return result 1170 } 1171 1172 // RPCMarshalBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are 1173 // returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain 1174 // transaction hashes. 1175 func RPCMarshalBlock(block *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) { 1176 fields := RPCMarshalHeader(block.Header()) 1177 fields["size"] = hexutil.Uint64(block.Size()) 1178 1179 if inclTx { 1180 formatTx := func(tx *types.Transaction) (interface{}, error) { 1181 return tx.Hash(), nil 1182 } 1183 if fullTx { 1184 formatTx = func(tx *types.Transaction) (interface{}, error) { 1185 return newRPCTransactionFromBlockHash(block, tx.Hash()), nil 1186 } 1187 } 1188 txs := block.Transactions() 1189 transactions := make([]interface{}, len(txs)) 1190 var err error 1191 for i, tx := range txs { 1192 if transactions[i], err = formatTx(tx); err != nil { 1193 return nil, err 1194 } 1195 } 1196 fields["transactions"] = transactions 1197 } 1198 uncles := block.Uncles() 1199 uncleHashes := make([]common.Hash, len(uncles)) 1200 for i, uncle := range uncles { 1201 uncleHashes[i] = uncle.Hash() 1202 } 1203 fields["uncles"] = uncleHashes 1204 1205 return fields, nil 1206 } 1207 1208 // rpcMarshalHeader uses the generalized output filler, then adds the total difficulty field, which requires 1209 // a `PublicBlockchainAPI`. 1210 func (s *PublicBlockChainAPI) rpcMarshalHeader(ctx context.Context, header *types.Header) map[string]interface{} { 1211 fields := RPCMarshalHeader(header) 1212 fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(ctx, header.Hash())) 1213 return fields 1214 } 1215 1216 // rpcMarshalBlock uses the generalized output filler, then adds the total difficulty field, which requires 1217 // a `PublicBlockchainAPI`. 1218 func (s *PublicBlockChainAPI) rpcMarshalBlock(ctx context.Context, b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) { 1219 fields, err := RPCMarshalBlock(b, inclTx, fullTx) 1220 if err != nil { 1221 return nil, err 1222 } 1223 if inclTx { 1224 fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(ctx, b.Hash())) 1225 } 1226 return fields, err 1227 } 1228 1229 // RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction 1230 type RPCTransaction struct { 1231 BlockHash *common.Hash `json:"blockHash"` 1232 BlockNumber *hexutil.Big `json:"blockNumber"` 1233 From common.Address `json:"from"` 1234 Gas hexutil.Uint64 `json:"gas"` 1235 GasPrice *hexutil.Big `json:"gasPrice"` 1236 GasFeeCap *hexutil.Big `json:"maxFeePerGas,omitempty"` 1237 GasTipCap *hexutil.Big `json:"maxPriorityFeePerGas,omitempty"` 1238 Hash common.Hash `json:"hash"` 1239 Input hexutil.Bytes `json:"input"` 1240 Nonce hexutil.Uint64 `json:"nonce"` 1241 To *common.Address `json:"to"` 1242 TransactionIndex *hexutil.Uint64 `json:"transactionIndex"` 1243 Value *hexutil.Big `json:"value"` 1244 Type hexutil.Uint64 `json:"type"` 1245 Accesses *types.AccessList `json:"accessList,omitempty"` 1246 ChainID *hexutil.Big `json:"chainId,omitempty"` 1247 V *hexutil.Big `json:"v"` 1248 R *hexutil.Big `json:"r"` 1249 S *hexutil.Big `json:"s"` 1250 } 1251 1252 // newRPCTransaction returns a transaction that will serialize to the RPC 1253 // representation, with the given location metadata set (if available). 1254 func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64, baseFee *big.Int) *RPCTransaction { 1255 // Determine the signer. For replay-protected transactions, use the most permissive 1256 // signer, because we assume that signers are backwards-compatible with old 1257 // transactions. For non-protected transactions, the homestead signer signer is used 1258 // because the return value of ChainId is zero for those transactions. 1259 var signer types.Signer 1260 if tx.Protected() { 1261 signer = types.LatestSignerForChainID(tx.ChainId()) 1262 } else { 1263 signer = types.HomesteadSigner{} 1264 } 1265 from, _ := types.Sender(signer, tx) 1266 v, r, s := tx.RawSignatureValues() 1267 result := &RPCTransaction{ 1268 Type: hexutil.Uint64(tx.Type()), 1269 From: from, 1270 Gas: hexutil.Uint64(tx.Gas()), 1271 GasPrice: (*hexutil.Big)(tx.GasPrice()), 1272 Hash: tx.Hash(), 1273 Input: hexutil.Bytes(tx.Data()), 1274 Nonce: hexutil.Uint64(tx.Nonce()), 1275 To: tx.To(), 1276 Value: (*hexutil.Big)(tx.Value()), 1277 V: (*hexutil.Big)(v), 1278 R: (*hexutil.Big)(r), 1279 S: (*hexutil.Big)(s), 1280 } 1281 if blockHash != (common.Hash{}) { 1282 result.BlockHash = &blockHash 1283 result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber)) 1284 result.TransactionIndex = (*hexutil.Uint64)(&index) 1285 } 1286 switch tx.Type() { 1287 case types.AccessListTxType: 1288 al := tx.AccessList() 1289 result.Accesses = &al 1290 result.ChainID = (*hexutil.Big)(tx.ChainId()) 1291 case types.DynamicFeeTxType: 1292 al := tx.AccessList() 1293 result.Accesses = &al 1294 result.ChainID = (*hexutil.Big)(tx.ChainId()) 1295 result.GasFeeCap = (*hexutil.Big)(tx.GasFeeCap()) 1296 result.GasTipCap = (*hexutil.Big)(tx.GasTipCap()) 1297 // if the transaction has been mined, compute the effective gas price 1298 if baseFee != nil && blockHash != (common.Hash{}) { 1299 // price = min(tip, gasFeeCap - baseFee) + baseFee 1300 price := math.BigMin(new(big.Int).Add(tx.GasTipCap(), baseFee), tx.GasFeeCap()) 1301 result.GasPrice = (*hexutil.Big)(price) 1302 } else { 1303 result.GasPrice = nil 1304 } 1305 } 1306 return result 1307 } 1308 1309 // newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation 1310 func newRPCPendingTransaction(tx *types.Transaction, current *types.Header, config *params.ChainConfig) *RPCTransaction { 1311 var baseFee *big.Int 1312 if current != nil { 1313 baseFee = misc.CalcBaseFee(config, current) 1314 } 1315 return newRPCTransaction(tx, common.Hash{}, 0, 0, baseFee) 1316 } 1317 1318 // newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation. 1319 func newRPCTransactionFromBlockIndex(b *types.Block, index uint64) *RPCTransaction { 1320 txs := b.Transactions() 1321 if index >= uint64(len(txs)) { 1322 return nil 1323 } 1324 return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index, b.BaseFee()) 1325 } 1326 1327 // newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index. 1328 func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes { 1329 txs := b.Transactions() 1330 if index >= uint64(len(txs)) { 1331 return nil 1332 } 1333 blob, _ := txs[index].MarshalBinary() 1334 return blob 1335 } 1336 1337 // newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation. 1338 func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction { 1339 for idx, tx := range b.Transactions() { 1340 if tx.Hash() == hash { 1341 return newRPCTransactionFromBlockIndex(b, uint64(idx)) 1342 } 1343 } 1344 return nil 1345 } 1346 1347 // accessListResult returns an optional accesslist 1348 // Its the result of the `debug_createAccessList` RPC call. 1349 // It contains an error if the transaction itself failed. 1350 type accessListResult struct { 1351 Accesslist *types.AccessList `json:"accessList"` 1352 Error string `json:"error,omitempty"` 1353 GasUsed hexutil.Uint64 `json:"gasUsed"` 1354 } 1355 1356 // CreateAccessList creates a EIP-2930 type AccessList for the given transaction. 1357 // Reexec and BlockNrOrHash can be specified to create the accessList on top of a certain state. 1358 func (s *PublicBlockChainAPI) CreateAccessList(ctx context.Context, args TransactionArgs, blockNrOrHash *rpc.BlockNumberOrHash) (*accessListResult, error) { 1359 bNrOrHash := rpc.BlockNumberOrHashWithNumber(rpc.PendingBlockNumber) 1360 if blockNrOrHash != nil { 1361 bNrOrHash = *blockNrOrHash 1362 } 1363 acl, gasUsed, vmerr, err := AccessList(ctx, s.b, bNrOrHash, args) 1364 if err != nil { 1365 return nil, err 1366 } 1367 result := &accessListResult{Accesslist: &acl, GasUsed: hexutil.Uint64(gasUsed)} 1368 if vmerr != nil { 1369 result.Error = vmerr.Error() 1370 } 1371 return result, nil 1372 } 1373 1374 // AccessList creates an access list for the given transaction. 1375 // If the accesslist creation fails an error is returned. 1376 // If the transaction itself fails, an vmErr is returned. 1377 func AccessList(ctx context.Context, b Backend, blockNrOrHash rpc.BlockNumberOrHash, args TransactionArgs) (acl types.AccessList, gasUsed uint64, vmErr error, err error) { 1378 // Retrieve the execution context 1379 db, header, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash) 1380 if db == nil || err != nil { 1381 return nil, 0, nil, err 1382 } 1383 // If the gas amount is not set, extract this as it will depend on access 1384 // lists and we'll need to reestimate every time 1385 nogas := args.Gas == nil 1386 1387 // Ensure any missing fields are filled, extract the recipient and input data 1388 if err := args.setDefaults(ctx, b); err != nil { 1389 return nil, 0, nil, err 1390 } 1391 var to common.Address 1392 if args.To != nil { 1393 to = *args.To 1394 } else { 1395 to = crypto.CreateAddress(args.from(), uint64(*args.Nonce)) 1396 } 1397 // Retrieve the precompiles since they don't need to be added to the access list 1398 precompiles := vm.ActivePrecompiles(b.ChainConfig().Rules(header.Number)) 1399 1400 // Create an initial tracer 1401 prevTracer := vm.NewAccessListTracer(nil, args.from(), to, precompiles) 1402 if args.AccessList != nil { 1403 prevTracer = vm.NewAccessListTracer(*args.AccessList, args.from(), to, precompiles) 1404 } 1405 for { 1406 // Retrieve the current access list to expand 1407 accessList := prevTracer.AccessList() 1408 log.Trace("Creating access list", "input", accessList) 1409 1410 // If no gas amount was specified, each unique access list needs it's own 1411 // gas calculation. This is quite expensive, but we need to be accurate 1412 // and it's convered by the sender only anyway. 1413 if nogas { 1414 args.Gas = nil 1415 if err := args.setDefaults(ctx, b); err != nil { 1416 return nil, 0, nil, err // shouldn't happen, just in case 1417 } 1418 } 1419 // Copy the original db so we don't modify it 1420 statedb := db.Copy() 1421 msg := types.NewMessage(args.from(), args.To, uint64(*args.Nonce), args.Value.ToInt(), uint64(*args.Gas), args.GasPrice.ToInt(), big.NewInt(0), big.NewInt(0), args.data(), accessList, false) 1422 1423 // Apply the transaction with the access list tracer 1424 tracer := vm.NewAccessListTracer(accessList, args.from(), to, precompiles) 1425 config := vm.Config{Tracer: tracer, Debug: true, NoBaseFee: true} 1426 vmenv, _, err := b.GetEVM(ctx, msg, statedb, header, &config) 1427 if err != nil { 1428 return nil, 0, nil, err 1429 } 1430 res, err := core.ApplyMessage(vmenv, msg, new(core.GasPool).AddGas(msg.Gas())) 1431 if err != nil { 1432 return nil, 0, nil, fmt.Errorf("failed to apply transaction: %v err: %v", args.toTransaction().Hash(), err) 1433 } 1434 if tracer.Equal(prevTracer) { 1435 return accessList, res.UsedGas, res.Err, nil 1436 } 1437 prevTracer = tracer 1438 } 1439 } 1440 1441 // PublicTransactionPoolAPI exposes methods for the RPC interface 1442 type PublicTransactionPoolAPI struct { 1443 b Backend 1444 nonceLock *AddrLocker 1445 signer types.Signer 1446 } 1447 1448 // NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool. 1449 func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI { 1450 // The signer used by the API should always be the 'latest' known one because we expect 1451 // signers to be backwards-compatible with old transactions. 1452 signer := types.LatestSigner(b.ChainConfig()) 1453 return &PublicTransactionPoolAPI{b, nonceLock, signer} 1454 } 1455 1456 // GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number. 1457 func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint { 1458 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 1459 n := hexutil.Uint(len(block.Transactions())) 1460 return &n 1461 } 1462 return nil 1463 } 1464 1465 // GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash. 1466 func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint { 1467 if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil { 1468 n := hexutil.Uint(len(block.Transactions())) 1469 return &n 1470 } 1471 return nil 1472 } 1473 1474 // GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index. 1475 func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction { 1476 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 1477 return newRPCTransactionFromBlockIndex(block, uint64(index)) 1478 } 1479 return nil 1480 } 1481 1482 // GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index. 1483 func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction { 1484 if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil { 1485 return newRPCTransactionFromBlockIndex(block, uint64(index)) 1486 } 1487 return nil 1488 } 1489 1490 // GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index. 1491 func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes { 1492 if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil { 1493 return newRPCRawTransactionFromBlockIndex(block, uint64(index)) 1494 } 1495 return nil 1496 } 1497 1498 // GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index. 1499 func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes { 1500 if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil { 1501 return newRPCRawTransactionFromBlockIndex(block, uint64(index)) 1502 } 1503 return nil 1504 } 1505 1506 // GetTransactionCount returns the number of transactions the given address has sent for the given block number 1507 func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (*hexutil.Uint64, error) { 1508 // Ask transaction pool for the nonce which includes pending transactions 1509 if blockNr, ok := blockNrOrHash.Number(); ok && blockNr == rpc.PendingBlockNumber { 1510 nonce, err := s.b.GetPoolNonce(ctx, address) 1511 if err != nil { 1512 return nil, err 1513 } 1514 return (*hexutil.Uint64)(&nonce), nil 1515 } 1516 // Resolve block number and use its state to ask for the nonce 1517 state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash) 1518 if state == nil || err != nil { 1519 return nil, err 1520 } 1521 nonce := state.GetNonce(address) 1522 return (*hexutil.Uint64)(&nonce), state.Error() 1523 } 1524 1525 // GetTransactionByHash returns the transaction for the given hash 1526 func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) (*RPCTransaction, error) { 1527 // Try to return an already finalized transaction 1528 log.Warn("get transaction") 1529 tx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash) 1530 if err != nil { 1531 return nil, err 1532 } 1533 if tx != nil { 1534 log.Warn("transaction 1") 1535 header, err := s.b.HeaderByHash(ctx, blockHash) 1536 if err != nil { 1537 return nil, err 1538 } 1539 return newRPCTransaction(tx, blockHash, blockNumber, index, header.BaseFee), nil 1540 } 1541 // No finalized transaction, try to retrieve it from the pool 1542 if tx := s.b.GetPoolTransaction(hash); tx != nil { 1543 log.Warn("transaction 2") 1544 return newRPCPendingTransaction(tx, s.b.CurrentHeader(), s.b.ChainConfig()), nil 1545 } 1546 1547 // Transaction unknown, return as such 1548 return nil, nil 1549 } 1550 1551 // GetRawTransactionByHash returns the bytes of the transaction for the given hash. 1552 func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) { 1553 // Retrieve a finalized transaction, or a pooled otherwise 1554 tx, _, _, _, err := s.b.GetTransaction(ctx, hash) 1555 if err != nil { 1556 return nil, err 1557 } 1558 if tx == nil { 1559 if tx = s.b.GetPoolTransaction(hash); tx == nil { 1560 // Transaction not found anywhere, abort 1561 return nil, nil 1562 } 1563 } 1564 // Serialize to RLP and return 1565 return tx.MarshalBinary() 1566 } 1567 1568 // GetTransactionReceipt returns the transaction receipt for the given transaction hash. 1569 func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) { 1570 tx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash) 1571 if err != nil { 1572 return nil, nil 1573 } 1574 receipts, err := s.b.GetReceipts(ctx, blockHash) 1575 if err != nil { 1576 return nil, err 1577 } 1578 if len(receipts) <= int(index) { 1579 return nil, nil 1580 } 1581 receipt := receipts[index] 1582 1583 // Derive the sender. 1584 bigblock := new(big.Int).SetUint64(blockNumber) 1585 signer := types.MakeSigner(s.b.ChainConfig(), bigblock) 1586 from, _ := types.Sender(signer, tx) 1587 1588 fields := map[string]interface{}{ 1589 "blockHash": blockHash, 1590 "blockNumber": hexutil.Uint64(blockNumber), 1591 "transactionHash": hash, 1592 "transactionIndex": hexutil.Uint64(index), 1593 "from": from, 1594 "to": tx.To(), 1595 "gasUsed": hexutil.Uint64(receipt.GasUsed), 1596 "cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed), 1597 "contractAddress": nil, 1598 "logs": receipt.Logs, 1599 "logsBloom": receipt.Bloom, 1600 "type": hexutil.Uint(tx.Type()), 1601 } 1602 // Assign the effective gas price paid 1603 if !s.b.ChainConfig().IsLondon(bigblock) { 1604 fields["effectiveGasPrice"] = hexutil.Uint64(tx.GasPrice().Uint64()) 1605 } else { 1606 header, err := s.b.HeaderByHash(ctx, blockHash) 1607 if err != nil { 1608 return nil, err 1609 } 1610 gasPrice := new(big.Int).Add(header.BaseFee, tx.EffectiveGasTipValue(header.BaseFee)) 1611 fields["effectiveGasPrice"] = hexutil.Uint64(gasPrice.Uint64()) 1612 } 1613 // Assign receipt status or post state. 1614 if len(receipt.PostState) > 0 { 1615 fields["root"] = hexutil.Bytes(receipt.PostState) 1616 } else { 1617 fields["status"] = hexutil.Uint(receipt.Status) 1618 } 1619 if receipt.Logs == nil { 1620 fields["logs"] = [][]*types.Log{} 1621 } 1622 // If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation 1623 if receipt.ContractAddress != (common.Address{}) { 1624 fields["contractAddress"] = receipt.ContractAddress 1625 } 1626 return fields, nil 1627 } 1628 1629 // sign is a helper function that signs a transaction with the private key of the given address. 1630 func (s *PublicTransactionPoolAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) { 1631 // Look up the wallet containing the requested signer 1632 account := accounts.Account{Address: addr} 1633 1634 wallet, err := s.b.AccountManager().Find(account) 1635 if err != nil { 1636 return nil, err 1637 } 1638 // Request the wallet to sign the transaction 1639 return wallet.SignTx(account, tx, s.b.ChainConfig().ChainID) 1640 } 1641 1642 // SubmitTransaction is a helper function that submits tx to txPool and logs a message. 1643 func SubmitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) { 1644 // If the transaction fee cap is already specified, ensure the 1645 // fee of the given transaction is _reasonable_. 1646 if err := checkTxFee(tx.GasPrice(), tx.Gas(), b.RPCTxFeeCap()); err != nil { 1647 return common.Hash{}, err 1648 } 1649 if !b.UnprotectedAllowed() && !tx.Protected() { 1650 // Ensure only eip155 signed transactions are submitted if EIP155Required is set. 1651 return common.Hash{}, errors.New("only replay-protected (EIP-155) transactions allowed over RPC") 1652 } 1653 if err := b.SendTx(ctx, tx); err != nil { 1654 return common.Hash{}, err 1655 } 1656 // Print a log with full tx details for manual investigations and interventions 1657 signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number()) 1658 from, err := types.Sender(signer, tx) 1659 if err != nil { 1660 return common.Hash{}, err 1661 } 1662 1663 if tx.To() == nil { 1664 addr := crypto.CreateAddress(from, tx.Nonce()) 1665 log.Info("Submitted contract creation", "hash", tx.Hash().Hex(), "from", from, "nonce", tx.Nonce(), "contract", addr.Hex(), "value", tx.Value()) 1666 } else { 1667 log.Info("Submitted transaction", "hash", tx.Hash().Hex(), "from", from, "nonce", tx.Nonce(), "recipient", tx.To(), "value", tx.Value()) 1668 } 1669 return tx.Hash(), nil 1670 } 1671 1672 // SendTransaction creates a transaction for the given argument, sign it and submit it to the 1673 // transaction pool. 1674 func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args TransactionArgs) (common.Hash, error) { 1675 // Look up the wallet containing the requested signer 1676 account := accounts.Account{Address: args.from()} 1677 1678 wallet, err := s.b.AccountManager().Find(account) 1679 if err != nil { 1680 return common.Hash{}, err 1681 } 1682 1683 if args.Nonce == nil { 1684 // Hold the addresse's mutex around signing to prevent concurrent assignment of 1685 // the same nonce to multiple accounts. 1686 s.nonceLock.LockAddr(args.from()) 1687 defer s.nonceLock.UnlockAddr(args.from()) 1688 } 1689 1690 // Set some sanity defaults and terminate on failure 1691 if err := args.setDefaults(ctx, s.b); err != nil { 1692 return common.Hash{}, err 1693 } 1694 // Assemble the transaction and sign with the wallet 1695 tx := args.toTransaction() 1696 1697 signed, err := wallet.SignTx(account, tx, s.b.ChainConfig().ChainID) 1698 if err != nil { 1699 return common.Hash{}, err 1700 } 1701 return SubmitTransaction(ctx, s.b, signed) 1702 } 1703 1704 // FillTransaction fills the defaults (nonce, gas, gasPrice) on a given unsigned transaction, 1705 // and returns it to the caller for further processing (signing + broadcast) 1706 func (s *PublicTransactionPoolAPI) FillTransaction(ctx context.Context, args TransactionArgs) (*SignTransactionResult, error) { 1707 // Set some sanity defaults and terminate on failure 1708 if err := args.setDefaults(ctx, s.b); err != nil { 1709 return nil, err 1710 } 1711 // Assemble the transaction and obtain rlp 1712 tx := args.toTransaction() 1713 data, err := tx.MarshalBinary() 1714 if err != nil { 1715 return nil, err 1716 } 1717 return &SignTransactionResult{data, tx}, nil 1718 } 1719 1720 // SendRawTransaction will add the signed transaction to the transaction pool. 1721 // The sender is responsible for signing the transaction and using the correct nonce. 1722 func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, input hexutil.Bytes) (common.Hash, error) { 1723 tx := new(types.Transaction) 1724 if err := tx.UnmarshalBinary(input); err != nil { 1725 return common.Hash{}, err 1726 } 1727 return SubmitTransaction(ctx, s.b, tx) 1728 } 1729 1730 // Sign calculates an ECDSA signature for: 1731 // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message). 1732 // 1733 // Note, the produced signature conforms to the secp256k1 curve R, S and V values, 1734 // where the V value will be 27 or 28 for legacy reasons. 1735 // 1736 // The account associated with addr must be unlocked. 1737 // 1738 // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign 1739 func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) { 1740 // Look up the wallet containing the requested signer 1741 account := accounts.Account{Address: addr} 1742 1743 wallet, err := s.b.AccountManager().Find(account) 1744 if err != nil { 1745 return nil, err 1746 } 1747 // Sign the requested hash with the wallet 1748 signature, err := wallet.SignText(account, data) 1749 if err == nil { 1750 signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper 1751 } 1752 return signature, err 1753 } 1754 1755 // SignTransactionResult represents a RLP encoded signed transaction. 1756 type SignTransactionResult struct { 1757 Raw hexutil.Bytes `json:"raw"` 1758 Tx *types.Transaction `json:"tx"` 1759 } 1760 1761 // SignTransaction will sign the given transaction with the from account. 1762 // The node needs to have the private key of the account corresponding with 1763 // the given from address and it needs to be unlocked. 1764 func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args TransactionArgs) (*SignTransactionResult, error) { 1765 if args.Gas == nil { 1766 return nil, fmt.Errorf("gas not specified") 1767 } 1768 if args.GasPrice == nil { 1769 return nil, fmt.Errorf("gasPrice not specified") 1770 } 1771 if args.Nonce == nil { 1772 return nil, fmt.Errorf("nonce not specified") 1773 } 1774 if err := args.setDefaults(ctx, s.b); err != nil { 1775 return nil, err 1776 } 1777 // Before actually sign the transaction, ensure the transaction fee is reasonable. 1778 if err := checkTxFee(args.GasPrice.ToInt(), uint64(*args.Gas), s.b.RPCTxFeeCap()); err != nil { 1779 return nil, err 1780 } 1781 tx, err := s.sign(args.from(), args.toTransaction()) 1782 if err != nil { 1783 return nil, err 1784 } 1785 data, err := tx.MarshalBinary() 1786 if err != nil { 1787 return nil, err 1788 } 1789 return &SignTransactionResult{data, tx}, nil 1790 } 1791 1792 // PendingTransactions returns the transactions that are in the transaction pool 1793 // and have a from address that is one of the accounts this node manages. 1794 func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) { 1795 pending, err := s.b.GetPoolTransactions() 1796 if err != nil { 1797 return nil, err 1798 } 1799 accounts := make(map[common.Address]struct{}) 1800 for _, wallet := range s.b.AccountManager().Wallets() { 1801 for _, account := range wallet.Accounts() { 1802 accounts[account.Address] = struct{}{} 1803 } 1804 } 1805 curHeader := s.b.CurrentHeader() 1806 transactions := make([]*RPCTransaction, 0, len(pending)) 1807 for _, tx := range pending { 1808 from, _ := types.Sender(s.signer, tx) 1809 if _, exists := accounts[from]; exists { 1810 transactions = append(transactions, newRPCPendingTransaction(tx, curHeader, s.b.ChainConfig())) 1811 } 1812 } 1813 return transactions, nil 1814 } 1815 1816 // Resend accepts an existing transaction and a new gas price and limit. It will remove 1817 // the given transaction from the pool and reinsert it with the new gas price and limit. 1818 func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs TransactionArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) { 1819 if sendArgs.Nonce == nil { 1820 return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec") 1821 } 1822 if err := sendArgs.setDefaults(ctx, s.b); err != nil { 1823 return common.Hash{}, err 1824 } 1825 matchTx := sendArgs.toTransaction() 1826 1827 // Before replacing the old transaction, ensure the _new_ transaction fee is reasonable. 1828 var price = matchTx.GasPrice() 1829 if gasPrice != nil { 1830 price = gasPrice.ToInt() 1831 } 1832 var gas = matchTx.Gas() 1833 if gasLimit != nil { 1834 gas = uint64(*gasLimit) 1835 } 1836 if err := checkTxFee(price, gas, s.b.RPCTxFeeCap()); err != nil { 1837 return common.Hash{}, err 1838 } 1839 // Iterate the pending list for replacement 1840 pending, err := s.b.GetPoolTransactions() 1841 if err != nil { 1842 return common.Hash{}, err 1843 } 1844 for _, p := range pending { 1845 wantSigHash := s.signer.Hash(matchTx) 1846 pFrom, err := types.Sender(s.signer, p) 1847 if err == nil && pFrom == sendArgs.from() && s.signer.Hash(p) == wantSigHash { 1848 // Match. Re-sign and send the transaction. 1849 if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 { 1850 sendArgs.GasPrice = gasPrice 1851 } 1852 if gasLimit != nil && *gasLimit != 0 { 1853 sendArgs.Gas = gasLimit 1854 } 1855 signedTx, err := s.sign(sendArgs.from(), sendArgs.toTransaction()) 1856 if err != nil { 1857 return common.Hash{}, err 1858 } 1859 if err = s.b.SendTx(ctx, signedTx); err != nil { 1860 return common.Hash{}, err 1861 } 1862 return signedTx.Hash(), nil 1863 } 1864 } 1865 return common.Hash{}, fmt.Errorf("transaction %#x not found", matchTx.Hash()) 1866 } 1867 1868 // PublicDebugAPI is the collection of Ethereum APIs exposed over the public 1869 // debugging endpoint. 1870 type PublicDebugAPI struct { 1871 b Backend 1872 } 1873 1874 // NewPublicDebugAPI creates a new API definition for the public debug methods 1875 // of the Ethereum service. 1876 func NewPublicDebugAPI(b Backend) *PublicDebugAPI { 1877 return &PublicDebugAPI{b: b} 1878 } 1879 1880 // GetBlockRlp retrieves the RLP encoded for of a single block. 1881 func (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) { 1882 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1883 if block == nil { 1884 return "", fmt.Errorf("block #%d not found", number) 1885 } 1886 encoded, err := rlp.EncodeToBytes(block) 1887 if err != nil { 1888 return "", err 1889 } 1890 return fmt.Sprintf("%x", encoded), nil 1891 } 1892 1893 // TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the 1894 // given address, returning the address of the recovered signature 1895 // 1896 // This is a temporary method to debug the externalsigner integration, 1897 // TODO: Remove this method when the integration is mature 1898 func (api *PublicDebugAPI) TestSignCliqueBlock(ctx context.Context, address common.Address, number uint64) (common.Address, error) { 1899 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1900 if block == nil { 1901 return common.Address{}, fmt.Errorf("block #%d not found", number) 1902 } 1903 header := block.Header() 1904 header.Extra = make([]byte, 32+65) 1905 encoded := clique.CliqueRLP(header) 1906 1907 // Look up the wallet containing the requested signer 1908 account := accounts.Account{Address: address} 1909 wallet, err := api.b.AccountManager().Find(account) 1910 if err != nil { 1911 return common.Address{}, err 1912 } 1913 1914 signature, err := wallet.SignData(account, accounts.MimetypeClique, encoded) 1915 if err != nil { 1916 return common.Address{}, err 1917 } 1918 sealHash := clique.SealHash(header).Bytes() 1919 log.Info("test signing of clique block", 1920 "Sealhash", fmt.Sprintf("%x", sealHash), 1921 "signature", fmt.Sprintf("%x", signature)) 1922 pubkey, err := crypto.Ecrecover(sealHash, signature) 1923 if err != nil { 1924 return common.Address{}, err 1925 } 1926 var signer common.Address 1927 copy(signer[:], crypto.Keccak256(pubkey[1:])[12:]) 1928 1929 return signer, nil 1930 } 1931 1932 // PrintBlock retrieves a block and returns its pretty printed form. 1933 func (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) { 1934 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1935 if block == nil { 1936 return "", fmt.Errorf("block #%d not found", number) 1937 } 1938 return spew.Sdump(block), nil 1939 } 1940 1941 // SeedHash retrieves the seed hash of a block. 1942 func (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) { 1943 block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number)) 1944 if block == nil { 1945 return "", fmt.Errorf("block #%d not found", number) 1946 } 1947 return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil 1948 } 1949 1950 // PrivateDebugAPI is the collection of Ethereum APIs exposed over the private 1951 // debugging endpoint. 1952 type PrivateDebugAPI struct { 1953 b Backend 1954 } 1955 1956 // NewPrivateDebugAPI creates a new API definition for the private debug methods 1957 // of the Ethereum service. 1958 func NewPrivateDebugAPI(b Backend) *PrivateDebugAPI { 1959 return &PrivateDebugAPI{b: b} 1960 } 1961 1962 // ChaindbProperty returns leveldb properties of the key-value database. 1963 func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) { 1964 if property == "" { 1965 property = "leveldb.stats" 1966 } else if !strings.HasPrefix(property, "leveldb.") { 1967 property = "leveldb." + property 1968 } 1969 return api.b.ChainDb().Stat(property) 1970 } 1971 1972 // ChaindbCompact flattens the entire key-value database into a single level, 1973 // removing all unused slots and merging all keys. 1974 func (api *PrivateDebugAPI) ChaindbCompact() error { 1975 for b := byte(0); b < 255; b++ { 1976 log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1)) 1977 if err := api.b.ChainDb().Compact([]byte{b}, []byte{b + 1}); err != nil { 1978 log.Error("Database compaction failed", "err", err) 1979 return err 1980 } 1981 } 1982 return nil 1983 } 1984 1985 // SetHead rewinds the head of the blockchain to a previous block. 1986 func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) { 1987 api.b.SetHead(uint64(number)) 1988 } 1989 1990 // PublicNetAPI offers network related RPC methods 1991 type PublicNetAPI struct { 1992 net *p2p.Server 1993 networkVersion uint64 1994 } 1995 1996 // NewPublicNetAPI creates a new net API instance. 1997 func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI { 1998 return &PublicNetAPI{net, networkVersion} 1999 } 2000 2001 // Listening returns an indication if the node is listening for network connections. 2002 func (s *PublicNetAPI) Listening() bool { 2003 return true // always listening 2004 } 2005 2006 // PeerCount returns the number of connected peers 2007 func (s *PublicNetAPI) PeerCount() hexutil.Uint { 2008 return hexutil.Uint(s.net.PeerCount()) 2009 } 2010 2011 // Version returns the current ethereum protocol version. 2012 func (s *PublicNetAPI) Version() string { 2013 return fmt.Sprintf("%d", s.networkVersion) 2014 } 2015 2016 // checkTxFee is an internal function used to check whether the fee of 2017 // the given transaction is _reasonable_(under the cap). 2018 func checkTxFee(gasPrice *big.Int, gas uint64, cap float64) error { 2019 // Short circuit if there is no cap for transaction fee at all. 2020 if cap == 0 { 2021 return nil 2022 } 2023 feeEth := new(big.Float).Quo(new(big.Float).SetInt(new(big.Int).Mul(gasPrice, new(big.Int).SetUint64(gas))), new(big.Float).SetInt(big.NewInt(params.Ether))) 2024 feeFloat, _ := feeEth.Float64() 2025 if feeFloat > cap { 2026 return fmt.Errorf("tx fee (%.2f ether) exceeds the configured cap (%.2f ether)", feeFloat, cap) 2027 } 2028 return nil 2029 } 2030 2031 // toHexSlice creates a slice of hex-strings based on []byte. 2032 func toHexSlice(b [][]byte) []string { 2033 r := make([]string, len(b)) 2034 for i := range b { 2035 r[i] = hexutil.Encode(b[i]) 2036 } 2037 return r 2038 }