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