| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472 |
- // Copyright 2015 The go-ethereum Authors
- // This file is part of the go-ethereum library.
- //
- // The go-ethereum library is free software: you can redistribute it and/or modify
- // it under the terms of the GNU Lesser General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // The go-ethereum library is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU Lesser General Public License for more details.
- //
- // You should have received a copy of the GNU Lesser General Public License
- // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
- package ethapi
- import (
- "context"
- "crypto/rand"
- "encoding/hex"
- "errors"
- "fmt"
- "github.com/ethereum/go-ethereum/consensus"
- "math/big"
- "strings"
- "time"
- "github.com/davecgh/go-spew/spew"
- "github.com/ethereum/go-ethereum/accounts"
- "github.com/ethereum/go-ethereum/accounts/abi"
- "github.com/ethereum/go-ethereum/accounts/keystore"
- "github.com/ethereum/go-ethereum/accounts/scwallet"
- "github.com/ethereum/go-ethereum/common"
- "github.com/ethereum/go-ethereum/common/hexutil"
- "github.com/ethereum/go-ethereum/common/math"
- "github.com/ethereum/go-ethereum/consensus/ethash"
- "github.com/ethereum/go-ethereum/consensus/misc"
- "github.com/ethereum/go-ethereum/core"
- "github.com/ethereum/go-ethereum/core/state"
- "github.com/ethereum/go-ethereum/core/types"
- "github.com/ethereum/go-ethereum/core/vm"
- "github.com/ethereum/go-ethereum/crypto"
- "github.com/ethereum/go-ethereum/eth/tracers/logger"
- "github.com/ethereum/go-ethereum/log"
- "github.com/ethereum/go-ethereum/p2p"
- "github.com/ethereum/go-ethereum/params"
- "github.com/ethereum/go-ethereum/rlp"
- "github.com/ethereum/go-ethereum/rpc"
- "github.com/tyler-smith/go-bip39"
- "golang.org/x/crypto/sha3"
- )
- // EthereumAPI provides an API to access Ethereum related information.
- type EthereumAPI struct {
- b Backend
- }
- // NewEthereumAPI creates a new Ethereum protocol API.
- func NewEthereumAPI(b Backend) *EthereumAPI {
- return &EthereumAPI{b}
- }
- // GasPrice returns a suggestion for a gas price for legacy transactions.
- func (s *EthereumAPI) GasPrice(ctx context.Context) (*hexutil.Big, error) {
- tipcap, err := s.b.SuggestGasTipCap(ctx)
- if err != nil {
- return nil, err
- }
- if head := s.b.CurrentHeader(); head.BaseFee != nil {
- tipcap.Add(tipcap, head.BaseFee)
- }
- return (*hexutil.Big)(tipcap), err
- }
- // MaxPriorityFeePerGas returns a suggestion for a gas tip cap for dynamic fee transactions.
- func (s *EthereumAPI) MaxPriorityFeePerGas(ctx context.Context) (*hexutil.Big, error) {
- tipcap, err := s.b.SuggestGasTipCap(ctx)
- if err != nil {
- return nil, err
- }
- return (*hexutil.Big)(tipcap), err
- }
- type feeHistoryResult struct {
- OldestBlock *hexutil.Big `json:"oldestBlock"`
- Reward [][]*hexutil.Big `json:"reward,omitempty"`
- BaseFee []*hexutil.Big `json:"baseFeePerGas,omitempty"`
- GasUsedRatio []float64 `json:"gasUsedRatio"`
- }
- // FeeHistory returns the fee market history.
- func (s *EthereumAPI) FeeHistory(ctx context.Context, blockCount rpc.DecimalOrHex, lastBlock rpc.BlockNumber, rewardPercentiles []float64) (*feeHistoryResult, error) {
- oldest, reward, baseFee, gasUsed, err := s.b.FeeHistory(ctx, int(blockCount), lastBlock, rewardPercentiles)
- if err != nil {
- return nil, err
- }
- results := &feeHistoryResult{
- OldestBlock: (*hexutil.Big)(oldest),
- GasUsedRatio: gasUsed,
- }
- if reward != nil {
- results.Reward = make([][]*hexutil.Big, len(reward))
- for i, w := range reward {
- results.Reward[i] = make([]*hexutil.Big, len(w))
- for j, v := range w {
- results.Reward[i][j] = (*hexutil.Big)(v)
- }
- }
- }
- if baseFee != nil {
- results.BaseFee = make([]*hexutil.Big, len(baseFee))
- for i, v := range baseFee {
- results.BaseFee[i] = (*hexutil.Big)(v)
- }
- }
- return results, nil
- }
- // Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not
- // yet received the latest block headers from its pears. In case it is synchronizing:
- // - startingBlock: block number this node started to synchronise from
- // - currentBlock: block number this node is currently importing
- // - highestBlock: block number of the highest block header this node has received from peers
- // - pulledStates: number of state entries processed until now
- // - knownStates: number of known state entries that still need to be pulled
- func (s *EthereumAPI) Syncing() (interface{}, error) {
- progress := s.b.SyncProgress()
- // Return not syncing if the synchronisation already completed
- if progress.CurrentBlock >= progress.HighestBlock {
- return false, nil
- }
- // Otherwise gather the block sync stats
- return map[string]interface{}{
- "startingBlock": hexutil.Uint64(progress.StartingBlock),
- "currentBlock": hexutil.Uint64(progress.CurrentBlock),
- "highestBlock": hexutil.Uint64(progress.HighestBlock),
- "syncedAccounts": hexutil.Uint64(progress.SyncedAccounts),
- "syncedAccountBytes": hexutil.Uint64(progress.SyncedAccountBytes),
- "syncedBytecodes": hexutil.Uint64(progress.SyncedBytecodes),
- "syncedBytecodeBytes": hexutil.Uint64(progress.SyncedBytecodeBytes),
- "syncedStorage": hexutil.Uint64(progress.SyncedStorage),
- "syncedStorageBytes": hexutil.Uint64(progress.SyncedStorageBytes),
- "healedTrienodes": hexutil.Uint64(progress.HealedTrienodes),
- "healedTrienodeBytes": hexutil.Uint64(progress.HealedTrienodeBytes),
- "healedBytecodes": hexutil.Uint64(progress.HealedBytecodes),
- "healedBytecodeBytes": hexutil.Uint64(progress.HealedBytecodeBytes),
- "healingTrienodes": hexutil.Uint64(progress.HealingTrienodes),
- "healingBytecode": hexutil.Uint64(progress.HealingBytecode),
- }, nil
- }
- // TxPoolAPI offers and API for the transaction pool. It only operates on data that is non confidential.
- type TxPoolAPI struct {
- b Backend
- }
- // NewTxPoolAPI creates a new tx pool service that gives information about the transaction pool.
- func NewTxPoolAPI(b Backend) *TxPoolAPI {
- return &TxPoolAPI{b}
- }
- // Content returns the transactions contained within the transaction pool.
- func (s *TxPoolAPI) Content() map[string]map[string]map[string]*RPCTransaction {
- content := map[string]map[string]map[string]*RPCTransaction{
- "pending": make(map[string]map[string]*RPCTransaction),
- "queued": make(map[string]map[string]*RPCTransaction),
- }
- pending, queue := s.b.TxPoolContent()
- curHeader := s.b.CurrentHeader()
- // Flatten the pending transactions
- for account, txs := range pending {
- dump := make(map[string]*RPCTransaction)
- for _, tx := range txs {
- dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx, curHeader, s.b.ChainConfig())
- }
- content["pending"][account.Hex()] = dump
- }
- // Flatten the queued transactions
- for account, txs := range queue {
- dump := make(map[string]*RPCTransaction)
- for _, tx := range txs {
- dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx, curHeader, s.b.ChainConfig())
- }
- content["queued"][account.Hex()] = dump
- }
- return content
- }
- // ContentFrom returns the transactions contained within the transaction pool.
- func (s *TxPoolAPI) ContentFrom(addr common.Address) map[string]map[string]*RPCTransaction {
- content := make(map[string]map[string]*RPCTransaction, 2)
- pending, queue := s.b.TxPoolContentFrom(addr)
- curHeader := s.b.CurrentHeader()
- // Build the pending transactions
- dump := make(map[string]*RPCTransaction, len(pending))
- for _, tx := range pending {
- dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx, curHeader, s.b.ChainConfig())
- }
- content["pending"] = dump
- // Build the queued transactions
- dump = make(map[string]*RPCTransaction, len(queue))
- for _, tx := range queue {
- dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx, curHeader, s.b.ChainConfig())
- }
- content["queued"] = dump
- return content
- }
- // Status returns the number of pending and queued transaction in the pool.
- func (s *TxPoolAPI) Status() map[string]hexutil.Uint {
- pending, queue := s.b.Stats()
- return map[string]hexutil.Uint{
- "pending": hexutil.Uint(pending),
- "queued": hexutil.Uint(queue),
- }
- }
- // Inspect retrieves the content of the transaction pool and flattens it into an
- // easily inspectable list.
- func (s *TxPoolAPI) Inspect() map[string]map[string]map[string]string {
- content := map[string]map[string]map[string]string{
- "pending": make(map[string]map[string]string),
- "queued": make(map[string]map[string]string),
- }
- pending, queue := s.b.TxPoolContent()
- // Define a formatter to flatten a transaction into a string
- var format = func(tx *types.Transaction) string {
- if to := tx.To(); to != nil {
- return fmt.Sprintf("%s: %v wei + %v gas × %v wei", tx.To().Hex(), tx.Value(), tx.Gas(), tx.GasPrice())
- }
- return fmt.Sprintf("contract creation: %v wei + %v gas × %v wei", tx.Value(), tx.Gas(), tx.GasPrice())
- }
- // Flatten the pending transactions
- for account, txs := range pending {
- dump := make(map[string]string)
- for _, tx := range txs {
- dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx)
- }
- content["pending"][account.Hex()] = dump
- }
- // Flatten the queued transactions
- for account, txs := range queue {
- dump := make(map[string]string)
- for _, tx := range txs {
- dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx)
- }
- content["queued"][account.Hex()] = dump
- }
- return content
- }
- // EthereumAccountAPI provides an API to access accounts managed by this node.
- // It offers only methods that can retrieve accounts.
- type EthereumAccountAPI struct {
- am *accounts.Manager
- }
- // NewEthereumAccountAPI creates a new EthereumAccountAPI.
- func NewEthereumAccountAPI(am *accounts.Manager) *EthereumAccountAPI {
- return &EthereumAccountAPI{am: am}
- }
- // Accounts returns the collection of accounts this node manages.
- func (s *EthereumAccountAPI) Accounts() []common.Address {
- return s.am.Accounts()
- }
- // PersonalAccountAPI provides an API to access accounts managed by this node.
- // It offers methods to create, (un)lock en list accounts. Some methods accept
- // passwords and are therefore considered private by default.
- type PersonalAccountAPI struct {
- am *accounts.Manager
- nonceLock *AddrLocker
- b Backend
- }
- // NewPersonalAccountAPI create a new PersonalAccountAPI.
- func NewPersonalAccountAPI(b Backend, nonceLock *AddrLocker) *PersonalAccountAPI {
- return &PersonalAccountAPI{
- am: b.AccountManager(),
- nonceLock: nonceLock,
- b: b,
- }
- }
- // ListAccounts will return a list of addresses for accounts this node manages.
- func (s *PersonalAccountAPI) ListAccounts() []common.Address {
- return s.am.Accounts()
- }
- // rawWallet is a JSON representation of an accounts.Wallet interface, with its
- // data contents extracted into plain fields.
- type rawWallet struct {
- URL string `json:"url"`
- Status string `json:"status"`
- Failure string `json:"failure,omitempty"`
- Accounts []accounts.Account `json:"accounts,omitempty"`
- }
- // ListWallets will return a list of wallets this node manages.
- func (s *PersonalAccountAPI) ListWallets() []rawWallet {
- wallets := make([]rawWallet, 0) // return [] instead of nil if empty
- for _, wallet := range s.am.Wallets() {
- status, failure := wallet.Status()
- raw := rawWallet{
- URL: wallet.URL().String(),
- Status: status,
- Accounts: wallet.Accounts(),
- }
- if failure != nil {
- raw.Failure = failure.Error()
- }
- wallets = append(wallets, raw)
- }
- return wallets
- }
- // OpenWallet initiates a hardware wallet opening procedure, establishing a USB
- // connection and attempting to authenticate via the provided passphrase. Note,
- // the method may return an extra challenge requiring a second open (e.g. the
- // Trezor PIN matrix challenge).
- func (s *PersonalAccountAPI) OpenWallet(url string, passphrase *string) error {
- wallet, err := s.am.Wallet(url)
- if err != nil {
- return err
- }
- pass := ""
- if passphrase != nil {
- pass = *passphrase
- }
- return wallet.Open(pass)
- }
- // DeriveAccount requests a HD wallet to derive a new account, optionally pinning
- // it for later reuse.
- func (s *PersonalAccountAPI) DeriveAccount(url string, path string, pin *bool) (accounts.Account, error) {
- wallet, err := s.am.Wallet(url)
- if err != nil {
- return accounts.Account{}, err
- }
- derivPath, err := accounts.ParseDerivationPath(path)
- if err != nil {
- return accounts.Account{}, err
- }
- if pin == nil {
- pin = new(bool)
- }
- return wallet.Derive(derivPath, *pin)
- }
- // NewAccount will create a new account and returns the address for the new account.
- func (s *PersonalAccountAPI) NewAccount(password string) (common.Address, error) {
- ks, err := fetchKeystore(s.am)
- if err != nil {
- return common.Address{}, err
- }
- acc, err := ks.NewAccount(password)
- if err == nil {
- log.Info("Your new key was generated", "address", acc.Address)
- log.Warn("Please backup your key file!", "path", acc.URL.Path)
- log.Warn("Please remember your password!")
- return acc.Address, nil
- }
- return common.Address{}, err
- }
- // fetchKeystore retrieves the encrypted keystore from the account manager.
- func fetchKeystore(am *accounts.Manager) (*keystore.KeyStore, error) {
- if ks := am.Backends(keystore.KeyStoreType); len(ks) > 0 {
- return ks[0].(*keystore.KeyStore), nil
- }
- return nil, errors.New("local keystore not used")
- }
- // ImportRawKey stores the given hex encoded ECDSA key into the key directory,
- // encrypting it with the passphrase.
- func (s *PersonalAccountAPI) ImportRawKey(privkey string, password string) (common.Address, error) {
- key, err := crypto.HexToECDSA(privkey)
- if err != nil {
- return common.Address{}, err
- }
- ks, err := fetchKeystore(s.am)
- if err != nil {
- return common.Address{}, err
- }
- acc, err := ks.ImportECDSA(key, password)
- return acc.Address, err
- }
- // UnlockAccount will unlock the account associated with the given address with
- // the given password for duration seconds. If duration is nil it will use a
- // default of 300 seconds. It returns an indication if the account was unlocked.
- func (s *PersonalAccountAPI) UnlockAccount(ctx context.Context, addr common.Address, password string, duration *uint64) (bool, error) {
- // When the API is exposed by external RPC(http, ws etc), unless the user
- // explicitly specifies to allow the insecure account unlocking, otherwise
- // it is disabled.
- if s.b.ExtRPCEnabled() && !s.b.AccountManager().Config().InsecureUnlockAllowed {
- return false, errors.New("account unlock with HTTP access is forbidden")
- }
- const max = uint64(time.Duration(math.MaxInt64) / time.Second)
- var d time.Duration
- if duration == nil {
- d = 300 * time.Second
- } else if *duration > max {
- return false, errors.New("unlock duration too large")
- } else {
- d = time.Duration(*duration) * time.Second
- }
- ks, err := fetchKeystore(s.am)
- if err != nil {
- return false, err
- }
- err = ks.TimedUnlock(accounts.Account{Address: addr}, password, d)
- if err != nil {
- log.Warn("Failed account unlock attempt", "address", addr, "err", err)
- }
- return err == nil, err
- }
- // LockAccount will lock the account associated with the given address when it's unlocked.
- func (s *PersonalAccountAPI) LockAccount(addr common.Address) bool {
- if ks, err := fetchKeystore(s.am); err == nil {
- return ks.Lock(addr) == nil
- }
- return false
- }
- // signTransaction sets defaults and signs the given transaction
- // NOTE: the caller needs to ensure that the nonceLock is held, if applicable,
- // and release it after the transaction has been submitted to the tx pool
- func (s *PersonalAccountAPI) signTransaction(ctx context.Context, args *TransactionArgs, passwd string) (*types.Transaction, error) {
- // Look up the wallet containing the requested signer
- account := accounts.Account{Address: args.from()}
- wallet, err := s.am.Find(account)
- if err != nil {
- return nil, err
- }
- // Set some sanity defaults and terminate on failure
- if err := args.setDefaults(ctx, s.b); err != nil {
- return nil, err
- }
- // Assemble the transaction and sign with the wallet
- tx := args.toTransaction()
- header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber)
- chainId := s.b.ChainConfig().ChainID
- if header != nil && s.b.ChainConfig().IsEthPoWFork(header.Number) {
- chainId = s.b.ChainConfig().ChainID_ALT
- }
- return wallet.SignTxWithPassphrase(account, passwd, tx, chainId)
- }
- // SendTransaction will create a transaction from the given arguments and
- // tries to sign it with the key associated with args.From. If the given
- // passwd isn't able to decrypt the key it fails.
- func (s *PersonalAccountAPI) SendTransaction(ctx context.Context, args TransactionArgs, passwd string) (common.Hash, error) {
- if args.Nonce == nil {
- // Hold the addresse's mutex around signing to prevent concurrent assignment of
- // the same nonce to multiple accounts.
- s.nonceLock.LockAddr(args.from())
- defer s.nonceLock.UnlockAddr(args.from())
- }
- signed, err := s.signTransaction(ctx, &args, passwd)
- if err != nil {
- log.Warn("Failed transaction send attempt", "from", args.from(), "to", args.To, "value", args.Value.ToInt(), "err", err)
- return common.Hash{}, err
- }
- return SubmitTransaction(ctx, s.b, signed)
- }
- // SignTransaction will create a transaction from the given arguments and
- // tries to sign it with the key associated with args.From. If the given passwd isn't
- // able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast
- // to other nodes
- func (s *PersonalAccountAPI) SignTransaction(ctx context.Context, args TransactionArgs, passwd string) (*SignTransactionResult, error) {
- // No need to obtain the noncelock mutex, since we won't be sending this
- // tx into the transaction pool, but right back to the user
- if args.From == nil {
- return nil, fmt.Errorf("sender not specified")
- }
- if args.Gas == nil {
- return nil, fmt.Errorf("gas not specified")
- }
- if args.GasPrice == nil && (args.MaxFeePerGas == nil || args.MaxPriorityFeePerGas == nil) {
- return nil, fmt.Errorf("missing gasPrice or maxFeePerGas/maxPriorityFeePerGas")
- }
- if args.Nonce == nil {
- return nil, fmt.Errorf("nonce not specified")
- }
- // Before actually signing the transaction, ensure the transaction fee is reasonable.
- tx := args.toTransaction()
- if err := checkTxFee(tx.GasPrice(), tx.Gas(), s.b.RPCTxFeeCap()); err != nil {
- return nil, err
- }
- signed, err := s.signTransaction(ctx, &args, passwd)
- if err != nil {
- log.Warn("Failed transaction sign attempt", "from", args.from(), "to", args.To, "value", args.Value.ToInt(), "err", err)
- return nil, err
- }
- data, err := signed.MarshalBinary()
- if err != nil {
- return nil, err
- }
- return &SignTransactionResult{data, signed}, nil
- }
- // Sign calculates an Ethereum ECDSA signature for:
- // keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))
- //
- // Note, the produced signature conforms to the secp256k1 curve R, S and V values,
- // where the V value will be 27 or 28 for legacy reasons.
- //
- // The key used to calculate the signature is decrypted with the given password.
- //
- // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign
- func (s *PersonalAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {
- // Look up the wallet containing the requested signer
- account := accounts.Account{Address: addr}
- wallet, err := s.b.AccountManager().Find(account)
- if err != nil {
- return nil, err
- }
- // Assemble sign the data with the wallet
- signature, err := wallet.SignTextWithPassphrase(account, passwd, data)
- if err != nil {
- log.Warn("Failed data sign attempt", "address", addr, "err", err)
- return nil, err
- }
- signature[crypto.RecoveryIDOffset] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
- return signature, nil
- }
- // EcRecover returns the address for the account that was used to create the signature.
- // Note, this function is compatible with eth_sign and personal_sign. As such it recovers
- // the address of:
- // hash = keccak256("\x19Ethereum Signed Message:\n"${message length}${message})
- // addr = ecrecover(hash, signature)
- //
- // Note, the signature must conform to the secp256k1 curve R, S and V values, where
- // the V value must be 27 or 28 for legacy reasons.
- //
- // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover
- func (s *PersonalAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {
- if len(sig) != crypto.SignatureLength {
- return common.Address{}, fmt.Errorf("signature must be %d bytes long", crypto.SignatureLength)
- }
- if sig[crypto.RecoveryIDOffset] != 27 && sig[crypto.RecoveryIDOffset] != 28 {
- return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)")
- }
- sig[crypto.RecoveryIDOffset] -= 27 // Transform yellow paper V from 27/28 to 0/1
- rpk, err := crypto.SigToPub(accounts.TextHash(data), sig)
- if err != nil {
- return common.Address{}, err
- }
- return crypto.PubkeyToAddress(*rpk), nil
- }
- // InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key.
- func (s *PersonalAccountAPI) InitializeWallet(ctx context.Context, url string) (string, error) {
- wallet, err := s.am.Wallet(url)
- if err != nil {
- return "", err
- }
- entropy, err := bip39.NewEntropy(256)
- if err != nil {
- return "", err
- }
- mnemonic, err := bip39.NewMnemonic(entropy)
- if err != nil {
- return "", err
- }
- seed := bip39.NewSeed(mnemonic, "")
- switch wallet := wallet.(type) {
- case *scwallet.Wallet:
- return mnemonic, wallet.Initialize(seed)
- default:
- return "", fmt.Errorf("specified wallet does not support initialization")
- }
- }
- // Unpair deletes a pairing between wallet and geth.
- func (s *PersonalAccountAPI) Unpair(ctx context.Context, url string, pin string) error {
- wallet, err := s.am.Wallet(url)
- if err != nil {
- return err
- }
- switch wallet := wallet.(type) {
- case *scwallet.Wallet:
- return wallet.Unpair([]byte(pin))
- default:
- return fmt.Errorf("specified wallet does not support pairing")
- }
- }
- // BlockChainAPI provides an API to access Ethereum blockchain data.
- type BlockChainAPI struct {
- b Backend
- }
- // NewBlockChainAPI creates a new Ethereum blockchain API.
- func NewBlockChainAPI(b Backend) *BlockChainAPI {
- return &BlockChainAPI{b}
- }
- // ChainId is the EIP-155 replay-protection chain id for the current Ethereum chain config.
- //
- // Note, this method does not conform to EIP-695 because the configured chain ID is always
- // returned, regardless of the current head block. We used to return an error when the chain
- // wasn't synced up to a block where EIP-155 is enabled, but this behavior caused issues
- // in CL clients.
- func (api *BlockChainAPI) ChainId() *hexutil.Big {
- header, _ := api.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber)
- if header != nil && api.b.ChainConfig().IsEthPoWFork(header.Number) {
- return (*hexutil.Big)(api.b.ChainConfig().ChainID_ALT)
- }
- return (*hexutil.Big)(api.b.ChainConfig().ChainID)
- }
- // BlockNumber returns the block number of the chain head.
- func (s *BlockChainAPI) BlockNumber() hexutil.Uint64 {
- header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available
- return hexutil.Uint64(header.Number.Uint64())
- }
- // GetBalance returns the amount of wei for the given address in the state of the
- // given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta
- // block numbers are also allowed.
- func (s *BlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (*hexutil.Big, error) {
- state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- return (*hexutil.Big)(state.GetBalance(address)), state.Error()
- }
- // Result structs for GetProof
- type AccountResult struct {
- Address common.Address `json:"address"`
- AccountProof []string `json:"accountProof"`
- Balance *hexutil.Big `json:"balance"`
- CodeHash common.Hash `json:"codeHash"`
- Nonce hexutil.Uint64 `json:"nonce"`
- StorageHash common.Hash `json:"storageHash"`
- StorageProof []StorageResult `json:"storageProof"`
- }
- type StorageResult struct {
- Key string `json:"key"`
- Value *hexutil.Big `json:"value"`
- Proof []string `json:"proof"`
- }
- // GetProof returns the Merkle-proof for a given account and optionally some storage keys.
- func (s *BlockChainAPI) GetProof(ctx context.Context, address common.Address, storageKeys []string, blockNrOrHash rpc.BlockNumberOrHash) (*AccountResult, error) {
- state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- storageTrie := state.StorageTrie(address)
- storageHash := types.EmptyRootHash
- codeHash := state.GetCodeHash(address)
- storageProof := make([]StorageResult, len(storageKeys))
- // if we have a storageTrie, (which means the account exists), we can update the storagehash
- if storageTrie != nil {
- storageHash = storageTrie.Hash()
- } else {
- // no storageTrie means the account does not exist, so the codeHash is the hash of an empty bytearray.
- codeHash = crypto.Keccak256Hash(nil)
- }
- // create the proof for the storageKeys
- for i, key := range storageKeys {
- if storageTrie != nil {
- proof, storageError := state.GetStorageProof(address, common.HexToHash(key))
- if storageError != nil {
- return nil, storageError
- }
- storageProof[i] = StorageResult{key, (*hexutil.Big)(state.GetState(address, common.HexToHash(key)).Big()), toHexSlice(proof)}
- } else {
- storageProof[i] = StorageResult{key, &hexutil.Big{}, []string{}}
- }
- }
- // create the accountProof
- accountProof, proofErr := state.GetProof(address)
- if proofErr != nil {
- return nil, proofErr
- }
- return &AccountResult{
- Address: address,
- AccountProof: toHexSlice(accountProof),
- Balance: (*hexutil.Big)(state.GetBalance(address)),
- CodeHash: codeHash,
- Nonce: hexutil.Uint64(state.GetNonce(address)),
- StorageHash: storageHash,
- StorageProof: storageProof,
- }, state.Error()
- }
- // GetHeaderByNumber returns the requested canonical block header.
- // * When blockNr is -1 the chain head is returned.
- // * When blockNr is -2 the pending chain head is returned.
- func (s *BlockChainAPI) GetHeaderByNumber(ctx context.Context, number rpc.BlockNumber) (map[string]interface{}, error) {
- header, err := s.b.HeaderByNumber(ctx, number)
- if header != nil && err == nil {
- response := s.rpcMarshalHeader(ctx, header)
- if number == rpc.PendingBlockNumber {
- // Pending header need to nil out a few fields
- for _, field := range []string{"hash", "nonce", "miner"} {
- response[field] = nil
- }
- }
- return response, err
- }
- return nil, err
- }
- // GetHeaderByHash returns the requested header by hash.
- func (s *BlockChainAPI) GetHeaderByHash(ctx context.Context, hash common.Hash) map[string]interface{} {
- header, _ := s.b.HeaderByHash(ctx, hash)
- if header != nil {
- return s.rpcMarshalHeader(ctx, header)
- }
- return nil
- }
- // GetBlockByNumber returns the requested canonical block.
- // - When blockNr is -1 the chain head is returned.
- // - When blockNr is -2 the pending chain head is returned.
- // - When fullTx is true all transactions in the block are returned, otherwise
- // only the transaction hash is returned.
- func (s *BlockChainAPI) GetBlockByNumber(ctx context.Context, number rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) {
- block, err := s.b.BlockByNumber(ctx, number)
- if block != nil && err == nil {
- response, err := s.rpcMarshalBlock(ctx, block, true, fullTx)
- if err == nil && number == rpc.PendingBlockNumber {
- // Pending blocks need to nil out a few fields
- for _, field := range []string{"hash", "nonce", "miner"} {
- response[field] = nil
- }
- }
- return response, err
- }
- return nil, err
- }
- // GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full
- // detail, otherwise only the transaction hash is returned.
- func (s *BlockChainAPI) GetBlockByHash(ctx context.Context, hash common.Hash, fullTx bool) (map[string]interface{}, error) {
- block, err := s.b.BlockByHash(ctx, hash)
- if block != nil {
- return s.rpcMarshalBlock(ctx, block, true, fullTx)
- }
- return nil, err
- }
- // GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index.
- func (s *BlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {
- block, err := s.b.BlockByNumber(ctx, blockNr)
- if block != nil {
- uncles := block.Uncles()
- if index >= hexutil.Uint(len(uncles)) {
- log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index)
- return nil, nil
- }
- block = types.NewBlockWithHeader(uncles[index])
- return s.rpcMarshalBlock(ctx, block, false, false)
- }
- return nil, err
- }
- // GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index.
- func (s *BlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {
- block, err := s.b.BlockByHash(ctx, blockHash)
- if block != nil {
- uncles := block.Uncles()
- if index >= hexutil.Uint(len(uncles)) {
- log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index)
- return nil, nil
- }
- block = types.NewBlockWithHeader(uncles[index])
- return s.rpcMarshalBlock(ctx, block, false, false)
- }
- return nil, err
- }
- // GetUncleCountByBlockNumber returns number of uncles in the block for the given block number
- func (s *BlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
- if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
- n := hexutil.Uint(len(block.Uncles()))
- return &n
- }
- return nil
- }
- // GetUncleCountByBlockHash returns number of uncles in the block for the given block hash
- func (s *BlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
- if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
- n := hexutil.Uint(len(block.Uncles()))
- return &n
- }
- return nil
- }
- // GetCode returns the code stored at the given address in the state for the given block number.
- func (s *BlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (hexutil.Bytes, error) {
- state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- code := state.GetCode(address)
- return code, state.Error()
- }
- // GetStorageAt returns the storage from the state at the given address, key and
- // block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block
- // numbers are also allowed.
- func (s *BlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNrOrHash rpc.BlockNumberOrHash) (hexutil.Bytes, error) {
- state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- res := state.GetState(address, common.HexToHash(key))
- return res[:], state.Error()
- }
- // OverrideAccount indicates the overriding fields of account during the execution
- // of a message call.
- // Note, state and stateDiff can't be specified at the same time. If state is
- // set, message execution will only use the data in the given state. Otherwise
- // if statDiff is set, all diff will be applied first and then execute the call
- // message.
- type OverrideAccount struct {
- Nonce *hexutil.Uint64 `json:"nonce"`
- Code *hexutil.Bytes `json:"code"`
- Balance **hexutil.Big `json:"balance"`
- State *map[common.Hash]common.Hash `json:"state"`
- StateDiff *map[common.Hash]common.Hash `json:"stateDiff"`
- }
- // StateOverride is the collection of overridden accounts.
- type StateOverride map[common.Address]OverrideAccount
- // Apply overrides the fields of specified accounts into the given state.
- func (diff *StateOverride) Apply(state *state.StateDB) error {
- if diff == nil {
- return nil
- }
- for addr, account := range *diff {
- // Override account nonce.
- if account.Nonce != nil {
- state.SetNonce(addr, uint64(*account.Nonce))
- }
- // Override account(contract) code.
- if account.Code != nil {
- state.SetCode(addr, *account.Code)
- }
- // Override account balance.
- if account.Balance != nil {
- state.SetBalance(addr, (*big.Int)(*account.Balance))
- }
- if account.State != nil && account.StateDiff != nil {
- return fmt.Errorf("account %s has both 'state' and 'stateDiff'", addr.Hex())
- }
- // Replace entire state if caller requires.
- if account.State != nil {
- state.SetStorage(addr, *account.State)
- }
- // Apply state diff into specified accounts.
- if account.StateDiff != nil {
- for key, value := range *account.StateDiff {
- state.SetState(addr, key, value)
- }
- }
- }
- return nil
- }
- // BlockOverrides is a set of header fields to override.
- type BlockOverrides struct {
- Number *hexutil.Big
- Difficulty *hexutil.Big
- Time *hexutil.Big
- GasLimit *hexutil.Uint64
- Coinbase *common.Address
- Random *common.Hash
- BaseFee *hexutil.Big
- }
- // Apply overrides the given header fields into the given block context.
- func (diff *BlockOverrides) Apply(blockCtx *vm.BlockContext) {
- if diff == nil {
- return
- }
- if diff.Number != nil {
- blockCtx.BlockNumber = diff.Number.ToInt()
- }
- if diff.Difficulty != nil {
- blockCtx.Difficulty = diff.Difficulty.ToInt()
- }
- if diff.Time != nil {
- blockCtx.Time = diff.Time.ToInt()
- }
- if diff.GasLimit != nil {
- blockCtx.GasLimit = uint64(*diff.GasLimit)
- }
- if diff.Coinbase != nil {
- blockCtx.Coinbase = *diff.Coinbase
- }
- if diff.Random != nil {
- blockCtx.Random = diff.Random
- }
- if diff.BaseFee != nil {
- blockCtx.BaseFee = diff.BaseFee.ToInt()
- }
- }
- type ChainContextBackend interface {
- Engine() consensus.Engine
- HeaderByNumber(context.Context, rpc.BlockNumber) (*types.Header, error)
- }
- // ChainContext is an implementation of core.ChainContext. It's main use-case
- // is instantiating a vm.BlockContext without having access to the BlockChain object.
- type ChainContext struct {
- b ChainContextBackend
- ctx context.Context
- }
- // NewChainContext creates a new ChainContext object.
- func NewChainContext(ctx context.Context, backend ChainContextBackend) *ChainContext {
- return &ChainContext{ctx: ctx, b: backend}
- }
- func (context *ChainContext) Engine() consensus.Engine {
- return context.b.Engine()
- }
- func (context *ChainContext) GetHeader(hash common.Hash, number uint64) *types.Header {
- // This method is called to get the hash for a block number when executing the BLOCKHASH
- // opcode. Hence no need to search for non-canonical blocks.
- header, err := context.b.HeaderByNumber(context.ctx, rpc.BlockNumber(number))
- if err != nil || header.Hash() != hash {
- return nil
- }
- return header
- }
- func DoCall(ctx context.Context, b Backend, args TransactionArgs, blockNrOrHash rpc.BlockNumberOrHash, overrides *StateOverride, timeout time.Duration, globalGasCap uint64) (*core.ExecutionResult, error) {
- defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now())
- state, header, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- if err := overrides.Apply(state); err != nil {
- return nil, err
- }
- // Setup context so it may be cancelled the call has completed
- // or, in case of unmetered gas, setup a context with a timeout.
- var cancel context.CancelFunc
- if timeout > 0 {
- ctx, cancel = context.WithTimeout(ctx, timeout)
- } else {
- ctx, cancel = context.WithCancel(ctx)
- }
- // Make sure the context is cancelled when the call has completed
- // this makes sure resources are cleaned up.
- defer cancel()
- return doCall(ctx, b, args, state, header, timeout, new(core.GasPool).AddGas(globalGasCap), nil)
- }
- func doCall(ctx context.Context, b Backend, args TransactionArgs, state *state.StateDB, header *types.Header, timeout time.Duration, gp *core.GasPool, blockContext *vm.BlockContext) (*core.ExecutionResult, error) {
- // Get a new instance of the EVM.
- msg, err := args.ToMessage(gp.Gas(), header.BaseFee)
- if err != nil {
- return nil, err
- }
- evm, vmError, err := b.GetEVM(ctx, msg, state, header, &vm.Config{NoBaseFee: true}, blockContext)
- if err != nil {
- return nil, err
- }
- // Wait for the context to be done and cancel the evm. Even if the
- // EVM has finished, cancelling may be done (repeatedly)
- go func() {
- <-ctx.Done()
- evm.Cancel()
- }()
- // Execute the message.
- result, err := core.ApplyMessage(evm, msg, gp)
- if err := vmError(); err != nil {
- return nil, err
- }
- // If the timer caused an abort, return an appropriate error message
- if evm.Cancelled() {
- return nil, fmt.Errorf("execution aborted (timeout = %v)", timeout)
- }
- if err != nil {
- return result, fmt.Errorf("err: %w (supplied gas %d)", err, msg.Gas())
- }
- return result, nil
- }
- // BatchCallConfig is the config object to be passed to eth_batchCall.
- type BatchCallConfig struct {
- Block rpc.BlockNumberOrHash
- StateOverrides *StateOverride
- Calls []BatchCallArgs
- }
- // BatchCallArgs is the object specifying each call within eth_batchCall. It
- // extends TransactionArgs with the list of block metadata overrides.
- type BatchCallArgs struct {
- TransactionArgs
- BlockOverrides *BlockOverrides
- }
- // CallResult is the result of one call.
- type CallResult struct {
- Return hexutil.Bytes
- Error error
- }
- // BatchCall executes a series of transactions on the state of a given block as base.
- // The base state can be overridden once before transactions are executed.
- //
- // Additionally, each call can override block context fields such as number.
- //
- // Note, this function doesn't make any changes in the state/blockchain and is
- // useful to execute and retrieve values.
- func (s *BlockChainAPI) BatchCall(ctx context.Context, config BatchCallConfig) ([]CallResult, error) {
- state, header, err := s.b.StateAndHeaderByNumberOrHash(ctx, config.Block)
- if state == nil || err != nil {
- return nil, err
- }
- // State overrides are applied once before all calls
- if err := config.StateOverrides.Apply(state); err != nil {
- return nil, err
- }
- // Setup context so it may be cancelled before the calls completed
- // or, in case of unmetered gas, setup a context with a timeout.
- var (
- cancel context.CancelFunc
- timeout = s.b.RPCEVMTimeout()
- )
- if timeout > 0 {
- ctx, cancel = context.WithTimeout(ctx, timeout)
- } else {
- ctx, cancel = context.WithCancel(ctx)
- }
- // Make sure the context is cancelled when the call has completed
- // this makes sure resources are cleaned up.
- defer cancel()
- var (
- results []CallResult
- // Each tx and all the series of txes shouldn't consume more gas than cap
- globalGasCap = s.b.RPCGasCap()
- gp = new(core.GasPool).AddGas(globalGasCap)
- )
- for _, call := range config.Calls {
- blockContext := core.NewEVMBlockContext(header, NewChainContext(ctx, s.b), nil)
- if call.BlockOverrides != nil {
- call.BlockOverrides.Apply(&blockContext)
- }
- result, err := doCall(ctx, s.b, call.TransactionArgs, state, header, timeout, gp, &blockContext)
- if err != nil {
- return nil, err
- }
- // If the result contains a revert reason, try to unpack it.
- if len(result.Revert()) > 0 {
- result.Err = newRevertError(result)
- }
- results = append(results, CallResult{Return: result.Return(), Error: result.Err})
- }
- return results, nil
- }
- func newRevertError(result *core.ExecutionResult) *revertError {
- reason, errUnpack := abi.UnpackRevert(result.Revert())
- err := errors.New("execution reverted")
- if errUnpack == nil {
- err = fmt.Errorf("execution reverted: %v", reason)
- }
- return &revertError{
- error: err,
- reason: hexutil.Encode(result.Revert()),
- }
- }
- // revertError is an API error that encompasses an EVM revertal with JSON error
- // code and a binary data blob.
- type revertError struct {
- error
- reason string // revert reason hex encoded
- }
- // ErrorCode returns the JSON error code for a revertal.
- // See: https://github.com/ethereum/wiki/wiki/JSON-RPC-Error-Codes-Improvement-Proposal
- func (e *revertError) ErrorCode() int {
- return 3
- }
- // ErrorData returns the hex encoded revert reason.
- func (e *revertError) ErrorData() interface{} {
- return e.reason
- }
- // Call executes the given transaction on the state for the given block number.
- //
- // Additionally, the caller can specify a batch of contract for fields overriding.
- //
- // Note, this function doesn't make and changes in the state/blockchain and is
- // useful to execute and retrieve values.
- func (s *BlockChainAPI) Call(ctx context.Context, args TransactionArgs, blockNrOrHash rpc.BlockNumberOrHash, overrides *StateOverride) (hexutil.Bytes, error) {
- result, err := DoCall(ctx, s.b, args, blockNrOrHash, overrides, s.b.RPCEVMTimeout(), s.b.RPCGasCap())
- if err != nil {
- return nil, err
- }
- // If the result contains a revert reason, try to unpack and return it.
- if len(result.Revert()) > 0 {
- return nil, newRevertError(result)
- }
- return result.Return(), result.Err
- }
- func DoEstimateGas(ctx context.Context, b Backend, args TransactionArgs, blockNrOrHash rpc.BlockNumberOrHash, gasCap uint64) (hexutil.Uint64, error) {
- // Binary search the gas requirement, as it may be higher than the amount used
- var (
- lo uint64 = params.TxGas - 1
- hi uint64
- cap uint64
- )
- // Use zero address if sender unspecified.
- if args.From == nil {
- args.From = new(common.Address)
- }
- // Determine the highest gas limit can be used during the estimation.
- if args.Gas != nil && uint64(*args.Gas) >= params.TxGas {
- hi = uint64(*args.Gas)
- } else {
- // Retrieve the block to act as the gas ceiling
- block, err := b.BlockByNumberOrHash(ctx, blockNrOrHash)
- if err != nil {
- return 0, err
- }
- if block == nil {
- return 0, errors.New("block not found")
- }
- hi = block.GasLimit()
- }
- // Normalize the max fee per gas the call is willing to spend.
- var feeCap *big.Int
- if args.GasPrice != nil && (args.MaxFeePerGas != nil || args.MaxPriorityFeePerGas != nil) {
- return 0, errors.New("both gasPrice and (maxFeePerGas or maxPriorityFeePerGas) specified")
- } else if args.GasPrice != nil {
- feeCap = args.GasPrice.ToInt()
- } else if args.MaxFeePerGas != nil {
- feeCap = args.MaxFeePerGas.ToInt()
- } else {
- feeCap = common.Big0
- }
- // Recap the highest gas limit with account's available balance.
- if feeCap.BitLen() != 0 {
- state, _, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if err != nil {
- return 0, err
- }
- balance := state.GetBalance(*args.From) // from can't be nil
- available := new(big.Int).Set(balance)
- if args.Value != nil {
- if args.Value.ToInt().Cmp(available) >= 0 {
- return 0, errors.New("insufficient funds for transfer")
- }
- available.Sub(available, args.Value.ToInt())
- }
- allowance := new(big.Int).Div(available, feeCap)
- // If the allowance is larger than maximum uint64, skip checking
- if allowance.IsUint64() && hi > allowance.Uint64() {
- transfer := args.Value
- if transfer == nil {
- transfer = new(hexutil.Big)
- }
- log.Warn("Gas estimation capped by limited funds", "original", hi, "balance", balance,
- "sent", transfer.ToInt(), "maxFeePerGas", feeCap, "fundable", allowance)
- hi = allowance.Uint64()
- }
- }
- // Recap the highest gas allowance with specified gascap.
- if gasCap != 0 && hi > gasCap {
- log.Warn("Caller gas above allowance, capping", "requested", hi, "cap", gasCap)
- hi = gasCap
- }
- cap = hi
- // Create a helper to check if a gas allowance results in an executable transaction
- executable := func(gas uint64) (bool, *core.ExecutionResult, error) {
- args.Gas = (*hexutil.Uint64)(&gas)
- result, err := DoCall(ctx, b, args, blockNrOrHash, nil, 0, gasCap)
- if err != nil {
- if errors.Is(err, core.ErrIntrinsicGas) {
- return true, nil, nil // Special case, raise gas limit
- }
- return true, nil, err // Bail out
- }
- return result.Failed(), result, nil
- }
- // Execute the binary search and hone in on an executable gas limit
- for lo+1 < hi {
- mid := (hi + lo) / 2
- failed, _, err := executable(mid)
- // If the error is not nil(consensus error), it means the provided message
- // call or transaction will never be accepted no matter how much gas it is
- // assigned. Return the error directly, don't struggle any more.
- if err != nil {
- return 0, err
- }
- if failed {
- lo = mid
- } else {
- hi = mid
- }
- }
- // Reject the transaction as invalid if it still fails at the highest allowance
- if hi == cap {
- failed, result, err := executable(hi)
- if err != nil {
- return 0, err
- }
- if failed {
- if result != nil && result.Err != vm.ErrOutOfGas {
- if len(result.Revert()) > 0 {
- return 0, newRevertError(result)
- }
- return 0, result.Err
- }
- // Otherwise, the specified gas cap is too low
- return 0, fmt.Errorf("gas required exceeds allowance (%d)", cap)
- }
- }
- return hexutil.Uint64(hi), nil
- }
- // EstimateGas returns an estimate of the amount of gas needed to execute the
- // given transaction against the current pending block.
- func (s *BlockChainAPI) EstimateGas(ctx context.Context, args TransactionArgs, blockNrOrHash *rpc.BlockNumberOrHash) (hexutil.Uint64, error) {
- bNrOrHash := rpc.BlockNumberOrHashWithNumber(rpc.PendingBlockNumber)
- if blockNrOrHash != nil {
- bNrOrHash = *blockNrOrHash
- }
- return DoEstimateGas(ctx, s.b, args, bNrOrHash, s.b.RPCGasCap())
- }
- // RPCMarshalHeader converts the given header to the RPC output .
- func RPCMarshalHeader(head *types.Header) map[string]interface{} {
- result := map[string]interface{}{
- "number": (*hexutil.Big)(head.Number),
- "hash": head.Hash(),
- "parentHash": head.ParentHash,
- "nonce": head.Nonce,
- "mixHash": head.MixDigest,
- "sha3Uncles": head.UncleHash,
- "logsBloom": head.Bloom,
- "stateRoot": head.Root,
- "miner": head.Coinbase,
- "difficulty": (*hexutil.Big)(head.Difficulty),
- "extraData": hexutil.Bytes(head.Extra),
- "size": hexutil.Uint64(head.Size()),
- "gasLimit": hexutil.Uint64(head.GasLimit),
- "gasUsed": hexutil.Uint64(head.GasUsed),
- "timestamp": hexutil.Uint64(head.Time),
- "transactionsRoot": head.TxHash,
- "receiptsRoot": head.ReceiptHash,
- }
- if head.BaseFee != nil {
- result["baseFeePerGas"] = (*hexutil.Big)(head.BaseFee)
- }
- return result
- }
- // RPCMarshalBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are
- // returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain
- // transaction hashes.
- func RPCMarshalBlock(block *types.Block, inclTx bool, fullTx bool, config *params.ChainConfig) (map[string]interface{}, error) {
- fields := RPCMarshalHeader(block.Header())
- fields["size"] = hexutil.Uint64(block.Size())
- if inclTx {
- formatTx := func(tx *types.Transaction) (interface{}, error) {
- return tx.Hash(), nil
- }
- if fullTx {
- formatTx = func(tx *types.Transaction) (interface{}, error) {
- return newRPCTransactionFromBlockHash(block, tx.Hash(), config), nil
- }
- }
- txs := block.Transactions()
- transactions := make([]interface{}, len(txs))
- var err error
- for i, tx := range txs {
- if transactions[i], err = formatTx(tx); err != nil {
- return nil, err
- }
- }
- fields["transactions"] = transactions
- }
- uncles := block.Uncles()
- uncleHashes := make([]common.Hash, len(uncles))
- for i, uncle := range uncles {
- uncleHashes[i] = uncle.Hash()
- }
- fields["uncles"] = uncleHashes
- return fields, nil
- }
- // rpcMarshalHeader uses the generalized output filler, then adds the total difficulty field, which requires
- // a `BlockchainAPI`.
- func (s *BlockChainAPI) rpcMarshalHeader(ctx context.Context, header *types.Header) map[string]interface{} {
- fields := RPCMarshalHeader(header)
- fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(ctx, header.Hash()))
- return fields
- }
- // rpcMarshalBlock uses the generalized output filler, then adds the total difficulty field, which requires
- // a `BlockchainAPI`.
- func (s *BlockChainAPI) rpcMarshalBlock(ctx context.Context, b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
- fields, err := RPCMarshalBlock(b, inclTx, fullTx, s.b.ChainConfig())
- if err != nil {
- return nil, err
- }
- if inclTx {
- fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(ctx, b.Hash()))
- }
- return fields, err
- }
- // RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction
- type RPCTransaction struct {
- BlockHash *common.Hash `json:"blockHash"`
- BlockNumber *hexutil.Big `json:"blockNumber"`
- From common.Address `json:"from"`
- Gas hexutil.Uint64 `json:"gas"`
- GasPrice *hexutil.Big `json:"gasPrice"`
- GasFeeCap *hexutil.Big `json:"maxFeePerGas,omitempty"`
- GasTipCap *hexutil.Big `json:"maxPriorityFeePerGas,omitempty"`
- Hash common.Hash `json:"hash"`
- Input hexutil.Bytes `json:"input"`
- Nonce hexutil.Uint64 `json:"nonce"`
- To *common.Address `json:"to"`
- TransactionIndex *hexutil.Uint64 `json:"transactionIndex"`
- Value *hexutil.Big `json:"value"`
- Type hexutil.Uint64 `json:"type"`
- Accesses *types.AccessList `json:"accessList,omitempty"`
- ChainID *hexutil.Big `json:"chainId,omitempty"`
- V *hexutil.Big `json:"v"`
- R *hexutil.Big `json:"r"`
- S *hexutil.Big `json:"s"`
- }
- // newRPCTransaction returns a transaction that will serialize to the RPC
- // representation, with the given location metadata set (if available).
- func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64, baseFee *big.Int, config *params.ChainConfig) *RPCTransaction {
- signer := types.MakeSigner(config, new(big.Int).SetUint64(blockNumber))
- from, _ := types.Sender(signer, tx)
- v, r, s := tx.RawSignatureValues()
- result := &RPCTransaction{
- Type: hexutil.Uint64(tx.Type()),
- From: from,
- Gas: hexutil.Uint64(tx.Gas()),
- GasPrice: (*hexutil.Big)(tx.GasPrice()),
- Hash: tx.Hash(),
- Input: hexutil.Bytes(tx.Data()),
- Nonce: hexutil.Uint64(tx.Nonce()),
- To: tx.To(),
- Value: (*hexutil.Big)(tx.Value()),
- V: (*hexutil.Big)(v),
- R: (*hexutil.Big)(r),
- S: (*hexutil.Big)(s),
- }
- if blockHash != (common.Hash{}) {
- result.BlockHash = &blockHash
- result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber))
- result.TransactionIndex = (*hexutil.Uint64)(&index)
- }
- switch tx.Type() {
- case types.LegacyTxType:
- // if a legacy transaction has an EIP-155 chain id, include it explicitly
- if id := tx.ChainId(); id.Sign() != 0 {
- result.ChainID = (*hexutil.Big)(id)
- }
- case types.AccessListTxType:
- al := tx.AccessList()
- result.Accesses = &al
- result.ChainID = (*hexutil.Big)(tx.ChainId())
- case types.DynamicFeeTxType:
- al := tx.AccessList()
- result.Accesses = &al
- result.ChainID = (*hexutil.Big)(tx.ChainId())
- result.GasFeeCap = (*hexutil.Big)(tx.GasFeeCap())
- result.GasTipCap = (*hexutil.Big)(tx.GasTipCap())
- // if the transaction has been mined, compute the effective gas price
- if baseFee != nil && blockHash != (common.Hash{}) {
- // price = min(tip, gasFeeCap - baseFee) + baseFee
- price := math.BigMin(new(big.Int).Add(tx.GasTipCap(), baseFee), tx.GasFeeCap())
- result.GasPrice = (*hexutil.Big)(price)
- } else {
- result.GasPrice = (*hexutil.Big)(tx.GasFeeCap())
- }
- }
- return result
- }
- // newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation
- func newRPCPendingTransaction(tx *types.Transaction, current *types.Header, config *params.ChainConfig) *RPCTransaction {
- var baseFee *big.Int
- blockNumber := uint64(0)
- if current != nil {
- baseFee = misc.CalcBaseFee(config, current)
- blockNumber = current.Number.Uint64()
- }
- return newRPCTransaction(tx, common.Hash{}, blockNumber, 0, baseFee, config)
- }
- // newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation.
- func newRPCTransactionFromBlockIndex(b *types.Block, index uint64, config *params.ChainConfig) *RPCTransaction {
- txs := b.Transactions()
- if index >= uint64(len(txs)) {
- return nil
- }
- return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index, b.BaseFee(), config)
- }
- // newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index.
- func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes {
- txs := b.Transactions()
- if index >= uint64(len(txs)) {
- return nil
- }
- blob, _ := txs[index].MarshalBinary()
- return blob
- }
- // newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
- func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash, config *params.ChainConfig) *RPCTransaction {
- for idx, tx := range b.Transactions() {
- if tx.Hash() == hash {
- return newRPCTransactionFromBlockIndex(b, uint64(idx), config)
- }
- }
- return nil
- }
- // accessListResult returns an optional accesslist
- // Its the result of the `debug_createAccessList` RPC call.
- // It contains an error if the transaction itself failed.
- type accessListResult struct {
- Accesslist *types.AccessList `json:"accessList"`
- Error string `json:"error,omitempty"`
- GasUsed hexutil.Uint64 `json:"gasUsed"`
- }
- // CreateAccessList creates a EIP-2930 type AccessList for the given transaction.
- // Reexec and BlockNrOrHash can be specified to create the accessList on top of a certain state.
- func (s *BlockChainAPI) CreateAccessList(ctx context.Context, args TransactionArgs, blockNrOrHash *rpc.BlockNumberOrHash) (*accessListResult, error) {
- bNrOrHash := rpc.BlockNumberOrHashWithNumber(rpc.PendingBlockNumber)
- if blockNrOrHash != nil {
- bNrOrHash = *blockNrOrHash
- }
- acl, gasUsed, vmerr, err := AccessList(ctx, s.b, bNrOrHash, args)
- if err != nil {
- return nil, err
- }
- result := &accessListResult{Accesslist: &acl, GasUsed: hexutil.Uint64(gasUsed)}
- if vmerr != nil {
- result.Error = vmerr.Error()
- }
- return result, nil
- }
- // AccessList creates an access list for the given transaction.
- // If the accesslist creation fails an error is returned.
- // If the transaction itself fails, an vmErr is returned.
- func AccessList(ctx context.Context, b Backend, blockNrOrHash rpc.BlockNumberOrHash, args TransactionArgs) (acl types.AccessList, gasUsed uint64, vmErr error, err error) {
- // Retrieve the execution context
- db, header, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if db == nil || err != nil {
- return nil, 0, nil, err
- }
- // If the gas amount is not set, default to RPC gas cap.
- if args.Gas == nil {
- tmp := hexutil.Uint64(b.RPCGasCap())
- args.Gas = &tmp
- }
- // Ensure any missing fields are filled, extract the recipient and input data
- if err := args.setDefaults(ctx, b); err != nil {
- return nil, 0, nil, err
- }
- var to common.Address
- if args.To != nil {
- to = *args.To
- } else {
- to = crypto.CreateAddress(args.from(), uint64(*args.Nonce))
- }
- isPostMerge := header.Difficulty.Cmp(common.Big0) == 0
- // Retrieve the precompiles since they don't need to be added to the access list
- precompiles := vm.ActivePrecompiles(b.ChainConfig().Rules(header.Number, isPostMerge))
- // Create an initial tracer
- prevTracer := logger.NewAccessListTracer(nil, args.from(), to, precompiles)
- if args.AccessList != nil {
- prevTracer = logger.NewAccessListTracer(*args.AccessList, args.from(), to, precompiles)
- }
- for {
- // Retrieve the current access list to expand
- accessList := prevTracer.AccessList()
- log.Trace("Creating access list", "input", accessList)
- // Copy the original db so we don't modify it
- statedb := db.Copy()
- // Set the accesslist to the last al
- args.AccessList = &accessList
- msg, err := args.ToMessage(b.RPCGasCap(), header.BaseFee)
- if err != nil {
- return nil, 0, nil, err
- }
- // Apply the transaction with the access list tracer
- tracer := logger.NewAccessListTracer(accessList, args.from(), to, precompiles)
- config := vm.Config{Tracer: tracer, Debug: true, NoBaseFee: true}
- vmenv, _, err := b.GetEVM(ctx, msg, statedb, header, &config, nil)
- if err != nil {
- return nil, 0, nil, err
- }
- res, err := core.ApplyMessage(vmenv, msg, new(core.GasPool).AddGas(msg.Gas()))
- if err != nil {
- return nil, 0, nil, fmt.Errorf("failed to apply transaction: %v err: %v", args.toTransaction().Hash(), err)
- }
- if tracer.Equal(prevTracer) {
- return accessList, res.UsedGas, res.Err, nil
- }
- prevTracer = tracer
- }
- }
- // TransactionAPI exposes methods for reading and creating transaction data.
- type TransactionAPI struct {
- b Backend
- nonceLock *AddrLocker
- signer types.Signer
- }
- // NewTransactionAPI creates a new RPC service with methods for interacting with transactions.
- func NewTransactionAPI(b Backend, nonceLock *AddrLocker) *TransactionAPI {
- // The signer used by the API should always be the 'latest' known one because we expect
- // signers to be backwards-compatible with old transactions.
- signer := types.LatestSigner(b.ChainConfig())
- return &TransactionAPI{b, nonceLock, signer}
- }
- // GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
- func (s *TransactionAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
- if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
- n := hexutil.Uint(len(block.Transactions()))
- return &n
- }
- return nil
- }
- // GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
- func (s *TransactionAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
- if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
- n := hexutil.Uint(len(block.Transactions()))
- return &n
- }
- return nil
- }
- // GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
- func (s *TransactionAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
- if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
- return newRPCTransactionFromBlockIndex(block, uint64(index), s.b.ChainConfig())
- }
- return nil
- }
- // GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
- func (s *TransactionAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
- if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
- return newRPCTransactionFromBlockIndex(block, uint64(index), s.b.ChainConfig())
- }
- return nil
- }
- // GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
- func (s *TransactionAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
- if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
- return newRPCRawTransactionFromBlockIndex(block, uint64(index))
- }
- return nil
- }
- // GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
- func (s *TransactionAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
- if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
- return newRPCRawTransactionFromBlockIndex(block, uint64(index))
- }
- return nil
- }
- // GetTransactionCount returns the number of transactions the given address has sent for the given block number
- func (s *TransactionAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (*hexutil.Uint64, error) {
- // Ask transaction pool for the nonce which includes pending transactions
- if blockNr, ok := blockNrOrHash.Number(); ok && blockNr == rpc.PendingBlockNumber {
- nonce, err := s.b.GetPoolNonce(ctx, address)
- if err != nil {
- return nil, err
- }
- return (*hexutil.Uint64)(&nonce), nil
- }
- // Resolve block number and use its state to ask for the nonce
- state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- nonce := state.GetNonce(address)
- return (*hexutil.Uint64)(&nonce), state.Error()
- }
- // GetTransactionByHash returns the transaction for the given hash
- func (s *TransactionAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) (*RPCTransaction, error) {
- // Try to return an already finalized transaction
- tx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash)
- if err != nil {
- return nil, err
- }
- if tx != nil {
- header, err := s.b.HeaderByHash(ctx, blockHash)
- if err != nil {
- return nil, err
- }
- return newRPCTransaction(tx, blockHash, blockNumber, index, header.BaseFee, s.b.ChainConfig()), nil
- }
- // No finalized transaction, try to retrieve it from the pool
- if tx := s.b.GetPoolTransaction(hash); tx != nil {
- return newRPCPendingTransaction(tx, s.b.CurrentHeader(), s.b.ChainConfig()), nil
- }
- // Transaction unknown, return as such
- return nil, nil
- }
- // GetRawTransactionByHash returns the bytes of the transaction for the given hash.
- func (s *TransactionAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
- // Retrieve a finalized transaction, or a pooled otherwise
- tx, _, _, _, err := s.b.GetTransaction(ctx, hash)
- if err != nil {
- return nil, err
- }
- if tx == nil {
- if tx = s.b.GetPoolTransaction(hash); tx == nil {
- // Transaction not found anywhere, abort
- return nil, nil
- }
- }
- // Serialize to RLP and return
- return tx.MarshalBinary()
- }
- // GetTransactionReceipt returns the transaction receipt for the given transaction hash.
- func (s *TransactionAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {
- tx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash)
- if err != nil {
- // When the transaction doesn't exist, the RPC method should return JSON null
- // as per specification.
- return nil, nil
- }
- receipts, err := s.b.GetReceipts(ctx, blockHash)
- if err != nil {
- return nil, err
- }
- if len(receipts) <= int(index) {
- return nil, nil
- }
- receipt := receipts[index]
- // Derive the sender.
- bigblock := new(big.Int).SetUint64(blockNumber)
- signer := types.MakeSigner(s.b.ChainConfig(), bigblock)
- from, _ := types.Sender(signer, tx)
- fields := map[string]interface{}{
- "blockHash": blockHash,
- "blockNumber": hexutil.Uint64(blockNumber),
- "transactionHash": hash,
- "transactionIndex": hexutil.Uint64(index),
- "from": from,
- "to": tx.To(),
- "gasUsed": hexutil.Uint64(receipt.GasUsed),
- "cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed),
- "contractAddress": nil,
- "logs": receipt.Logs,
- "logsBloom": receipt.Bloom,
- "type": hexutil.Uint(tx.Type()),
- }
- // Assign the effective gas price paid
- if !s.b.ChainConfig().IsLondon(bigblock) {
- fields["effectiveGasPrice"] = hexutil.Uint64(tx.GasPrice().Uint64())
- } else {
- header, err := s.b.HeaderByHash(ctx, blockHash)
- if err != nil {
- return nil, err
- }
- gasPrice := new(big.Int).Add(header.BaseFee, tx.EffectiveGasTipValue(header.BaseFee))
- fields["effectiveGasPrice"] = hexutil.Uint64(gasPrice.Uint64())
- }
- // Assign receipt status or post state.
- if len(receipt.PostState) > 0 {
- fields["root"] = hexutil.Bytes(receipt.PostState)
- } else {
- fields["status"] = hexutil.Uint(receipt.Status)
- }
- if receipt.Logs == nil {
- fields["logs"] = []*types.Log{}
- }
- // If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
- if receipt.ContractAddress != (common.Address{}) {
- fields["contractAddress"] = receipt.ContractAddress
- }
- return fields, nil
- }
- // sign is a helper function that signs a transaction with the private key of the given address.
- func (s *TransactionAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) {
- // Look up the wallet containing the requested signer
- account := accounts.Account{Address: addr}
- wallet, err := s.b.AccountManager().Find(account)
- if err != nil {
- return nil, err
- }
- // Request the wallet to sign the transaction
- header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber)
- chainId := s.b.ChainConfig().ChainID
- if header != nil && s.b.ChainConfig().IsEthPoWFork(header.Number) {
- chainId = s.b.ChainConfig().ChainID_ALT
- }
- return wallet.SignTx(account, tx, chainId)
- }
- // SubmitTransaction is a helper function that submits tx to txPool and logs a message.
- func SubmitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) {
- // If the transaction fee cap is already specified, ensure the
- // fee of the given transaction is _reasonable_.
- if err := checkTxFee(tx.GasPrice(), tx.Gas(), b.RPCTxFeeCap()); err != nil {
- return common.Hash{}, err
- }
- if !b.UnprotectedAllowed() && !tx.Protected() {
- // Ensure only eip155 signed transactions are submitted if EIP155Required is set.
- return common.Hash{}, errors.New("only replay-protected (EIP-155) transactions allowed over RPC")
- }
- // check eip155 sign after EthPow block
- if b.ChainConfig().IsEthPoWFork(b.CurrentBlock().Number()) && !tx.Protected() {
- return common.Hash{}, errors.New("only replay-protected (EIP-155) transactions allowed")
- }
- if err := b.SendTx(ctx, tx); err != nil {
- return common.Hash{}, err
- }
- // Print a log with full tx details for manual investigations and interventions
- signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
- from, err := types.Sender(signer, tx)
- if err != nil {
- return common.Hash{}, err
- }
- if tx.To() == nil {
- addr := crypto.CreateAddress(from, tx.Nonce())
- log.Info("Submitted contract creation", "hash", tx.Hash().Hex(), "from", from, "nonce", tx.Nonce(), "contract", addr.Hex(), "value", tx.Value())
- } else {
- log.Info("Submitted transaction", "hash", tx.Hash().Hex(), "from", from, "nonce", tx.Nonce(), "recipient", tx.To(), "value", tx.Value())
- }
- return tx.Hash(), nil
- }
- // SendTransaction creates a transaction for the given argument, sign it and submit it to the
- // transaction pool.
- func (s *TransactionAPI) SendTransaction(ctx context.Context, args TransactionArgs) (common.Hash, error) {
- // Look up the wallet containing the requested signer
- account := accounts.Account{Address: args.from()}
- wallet, err := s.b.AccountManager().Find(account)
- if err != nil {
- return common.Hash{}, err
- }
- if args.Nonce == nil {
- // Hold the addresse's mutex around signing to prevent concurrent assignment of
- // the same nonce to multiple accounts.
- s.nonceLock.LockAddr(args.from())
- defer s.nonceLock.UnlockAddr(args.from())
- }
- // Set some sanity defaults and terminate on failure
- if err := args.setDefaults(ctx, s.b); err != nil {
- return common.Hash{}, err
- }
- // Assemble the transaction and sign with the wallet
- tx := args.toTransaction()
- header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber)
- chainId := s.b.ChainConfig().ChainID
- if header != nil && s.b.ChainConfig().IsEthPoWFork(header.Number) {
- chainId = s.b.ChainConfig().ChainID_ALT
- }
- signed, err := wallet.SignTx(account, tx, chainId)
- if err != nil {
- return common.Hash{}, err
- }
- return SubmitTransaction(ctx, s.b, signed)
- }
- // FillTransaction fills the defaults (nonce, gas, gasPrice or 1559 fields)
- // on a given unsigned transaction, and returns it to the caller for further
- // processing (signing + broadcast).
- func (s *TransactionAPI) FillTransaction(ctx context.Context, args TransactionArgs) (*SignTransactionResult, error) {
- // Set some sanity defaults and terminate on failure
- if err := args.setDefaults(ctx, s.b); err != nil {
- return nil, err
- }
- // Assemble the transaction and obtain rlp
- tx := args.toTransaction()
- data, err := tx.MarshalBinary()
- if err != nil {
- return nil, err
- }
- return &SignTransactionResult{data, tx}, nil
- }
- // SendRawTransaction will add the signed transaction to the transaction pool.
- // The sender is responsible for signing the transaction and using the correct nonce.
- func (s *TransactionAPI) SendRawTransaction(ctx context.Context, input hexutil.Bytes) (common.Hash, error) {
- tx := new(types.Transaction)
- if err := tx.UnmarshalBinary(input); err != nil {
- return common.Hash{}, err
- }
- return SubmitTransaction(ctx, s.b, tx)
- }
- // Sign calculates an ECDSA signature for:
- // keccak256("\x19Ethereum Signed Message:\n" + len(message) + message).
- //
- // Note, the produced signature conforms to the secp256k1 curve R, S and V values,
- // where the V value will be 27 or 28 for legacy reasons.
- //
- // The account associated with addr must be unlocked.
- //
- // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
- func (s *TransactionAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
- // Look up the wallet containing the requested signer
- account := accounts.Account{Address: addr}
- wallet, err := s.b.AccountManager().Find(account)
- if err != nil {
- return nil, err
- }
- // Sign the requested hash with the wallet
- signature, err := wallet.SignText(account, data)
- if err == nil {
- signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
- }
- return signature, err
- }
- // SignTransactionResult represents a RLP encoded signed transaction.
- type SignTransactionResult struct {
- Raw hexutil.Bytes `json:"raw"`
- Tx *types.Transaction `json:"tx"`
- }
- // SignTransaction will sign the given transaction with the from account.
- // The node needs to have the private key of the account corresponding with
- // the given from address and it needs to be unlocked.
- func (s *TransactionAPI) SignTransaction(ctx context.Context, args TransactionArgs) (*SignTransactionResult, error) {
- if args.Gas == nil {
- return nil, fmt.Errorf("gas not specified")
- }
- if args.GasPrice == nil && (args.MaxPriorityFeePerGas == nil || args.MaxFeePerGas == nil) {
- return nil, fmt.Errorf("missing gasPrice or maxFeePerGas/maxPriorityFeePerGas")
- }
- if args.Nonce == nil {
- return nil, fmt.Errorf("nonce not specified")
- }
- if err := args.setDefaults(ctx, s.b); err != nil {
- return nil, err
- }
- // Before actually sign the transaction, ensure the transaction fee is reasonable.
- tx := args.toTransaction()
- if err := checkTxFee(tx.GasPrice(), tx.Gas(), s.b.RPCTxFeeCap()); err != nil {
- return nil, err
- }
- signed, err := s.sign(args.from(), tx)
- if err != nil {
- return nil, err
- }
- data, err := signed.MarshalBinary()
- if err != nil {
- return nil, err
- }
- return &SignTransactionResult{data, signed}, nil
- }
- // PendingTransactions returns the transactions that are in the transaction pool
- // and have a from address that is one of the accounts this node manages.
- func (s *TransactionAPI) PendingTransactions() ([]*RPCTransaction, error) {
- pending, err := s.b.GetPoolTransactions()
- if err != nil {
- return nil, err
- }
- accounts := make(map[common.Address]struct{})
- for _, wallet := range s.b.AccountManager().Wallets() {
- for _, account := range wallet.Accounts() {
- accounts[account.Address] = struct{}{}
- }
- }
- curHeader := s.b.CurrentHeader()
- transactions := make([]*RPCTransaction, 0, len(pending))
- for _, tx := range pending {
- from, _ := types.Sender(s.signer, tx)
- if _, exists := accounts[from]; exists {
- transactions = append(transactions, newRPCPendingTransaction(tx, curHeader, s.b.ChainConfig()))
- }
- }
- return transactions, nil
- }
- // Resend accepts an existing transaction and a new gas price and limit. It will remove
- // the given transaction from the pool and reinsert it with the new gas price and limit.
- func (s *TransactionAPI) Resend(ctx context.Context, sendArgs TransactionArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {
- if sendArgs.Nonce == nil {
- return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec")
- }
- if err := sendArgs.setDefaults(ctx, s.b); err != nil {
- return common.Hash{}, err
- }
- matchTx := sendArgs.toTransaction()
- // Before replacing the old transaction, ensure the _new_ transaction fee is reasonable.
- var price = matchTx.GasPrice()
- if gasPrice != nil {
- price = gasPrice.ToInt()
- }
- var gas = matchTx.Gas()
- if gasLimit != nil {
- gas = uint64(*gasLimit)
- }
- if err := checkTxFee(price, gas, s.b.RPCTxFeeCap()); err != nil {
- return common.Hash{}, err
- }
- // Iterate the pending list for replacement
- pending, err := s.b.GetPoolTransactions()
- if err != nil {
- return common.Hash{}, err
- }
- for _, p := range pending {
- wantSigHash := s.signer.Hash(matchTx)
- pFrom, err := types.Sender(s.signer, p)
- if err == nil && pFrom == sendArgs.from() && s.signer.Hash(p) == wantSigHash {
- // Match. Re-sign and send the transaction.
- if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 {
- sendArgs.GasPrice = gasPrice
- }
- if gasLimit != nil && *gasLimit != 0 {
- sendArgs.Gas = gasLimit
- }
- signedTx, err := s.sign(sendArgs.from(), sendArgs.toTransaction())
- if err != nil {
- return common.Hash{}, err
- }
- if err = s.b.SendTx(ctx, signedTx); err != nil {
- return common.Hash{}, err
- }
- return signedTx.Hash(), nil
- }
- }
- return common.Hash{}, fmt.Errorf("transaction %#x not found", matchTx.Hash())
- }
- // DebugAPI is the collection of Ethereum APIs exposed over the debugging
- // namespace.
- type DebugAPI struct {
- b Backend
- }
- // NewDebugAPI creates a new instance of DebugAPI.
- func NewDebugAPI(b Backend) *DebugAPI {
- return &DebugAPI{b: b}
- }
- // GetHeaderRlp retrieves the RLP encoded for of a single header.
- func (api *DebugAPI) GetHeaderRlp(ctx context.Context, number uint64) (hexutil.Bytes, error) {
- header, _ := api.b.HeaderByNumber(ctx, rpc.BlockNumber(number))
- if header == nil {
- return nil, fmt.Errorf("header #%d not found", number)
- }
- return rlp.EncodeToBytes(header)
- }
- // GetBlockRlp retrieves the RLP encoded for of a single block.
- func (api *DebugAPI) GetBlockRlp(ctx context.Context, number uint64) (hexutil.Bytes, error) {
- block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
- if block == nil {
- return nil, fmt.Errorf("block #%d not found", number)
- }
- return rlp.EncodeToBytes(block)
- }
- // GetRawReceipts retrieves the binary-encoded raw receipts of a single block.
- func (api *DebugAPI) GetRawReceipts(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) ([]hexutil.Bytes, error) {
- var hash common.Hash
- if h, ok := blockNrOrHash.Hash(); ok {
- hash = h
- } else {
- block, err := api.b.BlockByNumberOrHash(ctx, blockNrOrHash)
- if err != nil {
- return nil, err
- }
- hash = block.Hash()
- }
- receipts, err := api.b.GetReceipts(ctx, hash)
- if err != nil {
- return nil, err
- }
- result := make([]hexutil.Bytes, len(receipts))
- for i, receipt := range receipts {
- b, err := receipt.MarshalBinary()
- if err != nil {
- return nil, err
- }
- result[i] = b
- }
- return result, nil
- }
- // PrintBlock retrieves a block and returns its pretty printed form.
- func (api *DebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) {
- block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
- if block == nil {
- return "", fmt.Errorf("block #%d not found", number)
- }
- return spew.Sdump(block), nil
- }
- // SeedHash retrieves the seed hash of a block.
- func (api *DebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) {
- block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
- if block == nil {
- return "", fmt.Errorf("block #%d not found", number)
- }
- return fmt.Sprintf("%#x", ethash.SeedHash(number)), nil
- }
- // ChaindbProperty returns leveldb properties of the key-value database.
- func (api *DebugAPI) ChaindbProperty(property string) (string, error) {
- if property == "" {
- property = "leveldb.stats"
- } else if !strings.HasPrefix(property, "leveldb.") {
- property = "leveldb." + property
- }
- return api.b.ChainDb().Stat(property)
- }
- // ChaindbCompact flattens the entire key-value database into a single level,
- // removing all unused slots and merging all keys.
- func (api *DebugAPI) ChaindbCompact() error {
- for b := byte(0); b < 255; b++ {
- log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
- if err := api.b.ChainDb().Compact([]byte{b}, []byte{b + 1}); err != nil {
- log.Error("Database compaction failed", "err", err)
- return err
- }
- }
- return nil
- }
- // SetHead rewinds the head of the blockchain to a previous block.
- func (api *DebugAPI) SetHead(number hexutil.Uint64) {
- api.b.SetHead(uint64(number))
- }
- // NetAPI offers network related RPC methods
- type NetAPI struct {
- net *p2p.Server
- networkVersion uint64
- }
- // NewNetAPI creates a new net API instance.
- func NewNetAPI(net *p2p.Server, networkVersion uint64) *NetAPI {
- return &NetAPI{net, networkVersion}
- }
- // Listening returns an indication if the node is listening for network connections.
- func (s *NetAPI) Listening() bool {
- return true // always listening
- }
- // PeerCount returns the number of connected peers
- func (s *NetAPI) PeerCount() hexutil.Uint {
- return hexutil.Uint(s.net.PeerCount())
- }
- // Version returns the current ethereum protocol version.
- func (s *NetAPI) Version() string {
- return fmt.Sprintf("%d", s.networkVersion)
- }
- // checkTxFee is an internal function used to check whether the fee of
- // the given transaction is _reasonable_(under the cap).
- func checkTxFee(gasPrice *big.Int, gas uint64, cap float64) error {
- // Short circuit if there is no cap for transaction fee at all.
- if cap == 0 {
- return nil
- }
- 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)))
- feeFloat, _ := feeEth.Float64()
- if feeFloat > cap {
- return fmt.Errorf("tx fee (%.2f ether) exceeds the configured cap (%.2f ether)", feeFloat, cap)
- }
- return nil
- }
- // toHexSlice creates a slice of hex-strings based on []byte.
- func toHexSlice(b [][]byte) []string {
- r := make([]string, len(b))
- for i := range b {
- r[i] = hexutil.Encode(b[i])
- }
- return r
- }
- // ---------------------------------------------------------------- FlashBots ----------------------------------------------------------------
- // BundleAPI offers an API for accepting bundled transactions
- type BundleAPI struct {
- b Backend
- chain *core.BlockChain
- }
- // NewBundleAPI creates a new Tx Bundle API instance.
- func NewBundleAPI(b Backend, chain *core.BlockChain) *BundleAPI {
- return &BundleAPI{b, chain}
- }
- // CallBundleArgs represents the arguments for a call.
- type CallBundleArgs struct {
- Txs []hexutil.Bytes `json:"txs"`
- BlockNumber rpc.BlockNumber `json:"blockNumber"`
- StateBlockNumberOrHash rpc.BlockNumberOrHash `json:"stateBlockNumber"`
- Coinbase *string `json:"coinbase"`
- Timestamp *uint64 `json:"timestamp"`
- Timeout *int64 `json:"timeout"`
- GasLimit *uint64 `json:"gasLimit"`
- Difficulty *big.Int `json:"difficulty"`
- BaseFee *big.Int `json:"baseFee"`
- }
- // CallBundle will simulate a bundle of transactions at the top of a given block
- // number with the state of another (or the same) block. This can be used to
- // simulate future blocks with the current state, or it can be used to simulate
- // a past block.
- // The sender is responsible for signing the transactions and using the correct
- // nonce and ensuring validity
- func (s *BundleAPI) CallBundle(ctx context.Context, args CallBundleArgs) (map[string]interface{}, error) {
- if len(args.Txs) == 0 {
- return nil, errors.New("bundle missing txs")
- }
- if args.BlockNumber == 0 {
- return nil, errors.New("bundle missing blockNumber")
- }
- var txs types.Transactions
- for _, encodedTx := range args.Txs {
- tx := new(types.Transaction)
- if err := tx.UnmarshalBinary(encodedTx); err != nil {
- return nil, err
- }
- txs = append(txs, tx)
- }
- defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now())
- timeoutMilliSeconds := int64(5000)
- if args.Timeout != nil {
- timeoutMilliSeconds = *args.Timeout
- }
- timeout := time.Millisecond * time.Duration(timeoutMilliSeconds)
- state, parent, err := s.b.StateAndHeaderByNumberOrHash(ctx, args.StateBlockNumberOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- blockNumber := big.NewInt(int64(args.BlockNumber))
- timestamp := parent.Time + 1
- if args.Timestamp != nil {
- timestamp = *args.Timestamp
- }
- coinbase := parent.Coinbase
- if args.Coinbase != nil {
- coinbase = common.HexToAddress(*args.Coinbase)
- }
- difficulty := parent.Difficulty
- if args.Difficulty != nil {
- difficulty = args.Difficulty
- }
- gasLimit := parent.GasLimit
- if args.GasLimit != nil {
- gasLimit = *args.GasLimit
- }
- var baseFee *big.Int
- if args.BaseFee != nil {
- baseFee = args.BaseFee
- } else if s.b.ChainConfig().IsLondon(big.NewInt(args.BlockNumber.Int64())) {
- baseFee = misc.CalcBaseFee(s.b.ChainConfig(), parent)
- }
- header := &types.Header{
- ParentHash: parent.Hash(),
- Number: blockNumber,
- GasLimit: gasLimit,
- Time: timestamp,
- Difficulty: difficulty,
- Coinbase: coinbase,
- BaseFee: baseFee,
- }
- // Setup context so it may be cancelled the call has completed
- // or, in case of unmetered gas, setup a context with a timeout.
- var cancel context.CancelFunc
- if timeout > 0 {
- ctx, cancel = context.WithTimeout(ctx, timeout)
- } else {
- ctx, cancel = context.WithCancel(ctx)
- }
- // Make sure the context is cancelled when the call has completed
- // this makes sure resources are cleaned up.
- defer cancel()
- vmconfig := vm.Config{}
- // Setup the gas pool (also for unmetered requests)
- // and apply the message.
- gp := new(core.GasPool).AddGas(math.MaxUint64)
- results := []map[string]interface{}{}
- coinbaseBalanceBefore := state.GetBalance(coinbase)
- bundleHash := sha3.NewLegacyKeccak256()
- signer := types.MakeSigner(s.b.ChainConfig(), blockNumber)
- var totalGasUsed uint64
- gasFees := new(big.Int)
- for i, tx := range txs {
- coinbaseBalanceBeforeTx := state.GetBalance(coinbase)
- state.Prepare(tx.Hash(), i)
- receipt, result, err := core.ApplyTransactionWithResult(s.b.ChainConfig(), s.chain, &coinbase, gp, state, header, tx, &header.GasUsed, vmconfig)
- if err != nil {
- return nil, fmt.Errorf("err: %w; txhash %s", err, tx.Hash())
- }
- txHash := tx.Hash().String()
- from, err := types.Sender(signer, tx)
- if err != nil {
- return nil, fmt.Errorf("err: %w; txhash %s", err, tx.Hash())
- }
- to := "0x"
- if tx.To() != nil {
- to = tx.To().String()
- }
- jsonResult := map[string]interface{}{
- "txHash": txHash,
- "gasUsed": receipt.GasUsed,
- "fromAddress": from.String(),
- "toAddress": to,
- }
- totalGasUsed += receipt.GasUsed
- gasPrice, err := tx.EffectiveGasTip(header.BaseFee)
- if err != nil {
- return nil, fmt.Errorf("err: %w; txhash %s", err, tx.Hash())
- }
- gasFeesTx := new(big.Int).Mul(big.NewInt(int64(receipt.GasUsed)), gasPrice)
- gasFees.Add(gasFees, gasFeesTx)
- bundleHash.Write(tx.Hash().Bytes())
- if result.Err != nil {
- jsonResult["error"] = result.Err.Error()
- revert := result.Revert()
- if len(revert) > 0 {
- jsonResult["revert"] = string(revert)
- }
- } else {
- dst := make([]byte, hex.EncodedLen(len(result.Return())))
- hex.Encode(dst, result.Return())
- jsonResult["value"] = "0x" + string(dst)
- }
- coinbaseDiffTx := new(big.Int).Sub(state.GetBalance(coinbase), coinbaseBalanceBeforeTx)
- jsonResult["coinbaseDiff"] = coinbaseDiffTx.String()
- jsonResult["gasFees"] = gasFeesTx.String()
- jsonResult["ethSentToCoinbase"] = new(big.Int).Sub(coinbaseDiffTx, gasFeesTx).String()
- jsonResult["gasPrice"] = new(big.Int).Div(coinbaseDiffTx, big.NewInt(int64(receipt.GasUsed))).String()
- jsonResult["gasUsed"] = receipt.GasUsed
- results = append(results, jsonResult)
- }
- ret := map[string]interface{}{}
- ret["results"] = results
- coinbaseDiff := new(big.Int).Sub(state.GetBalance(coinbase), coinbaseBalanceBefore)
- ret["coinbaseDiff"] = coinbaseDiff.String()
- ret["gasFees"] = gasFees.String()
- ret["ethSentToCoinbase"] = new(big.Int).Sub(coinbaseDiff, gasFees).String()
- ret["bundleGasPrice"] = new(big.Int).Div(coinbaseDiff, big.NewInt(int64(totalGasUsed))).String()
- ret["totalGasUsed"] = totalGasUsed
- ret["stateBlockNumber"] = parent.Number.Int64()
- ret["bundleHash"] = "0x" + common.Bytes2Hex(bundleHash.Sum(nil))
- return ret, nil
- }
- // EstimateGasBundleArgs represents the arguments for a call
- type EstimateGasBundleArgs struct {
- Txs []TransactionArgs `json:"txs"`
- BlockNumber rpc.BlockNumber `json:"blockNumber"`
- StateBlockNumberOrHash rpc.BlockNumberOrHash `json:"stateBlockNumber"`
- Coinbase *string `json:"coinbase"`
- Timestamp *uint64 `json:"timestamp"`
- Timeout *int64 `json:"timeout"`
- }
- func (s *BundleAPI) EstimateGasBundle(ctx context.Context, args EstimateGasBundleArgs) (map[string]interface{}, error) {
- if len(args.Txs) == 0 {
- return nil, errors.New("bundle missing txs")
- }
- if args.BlockNumber == 0 {
- return nil, errors.New("bundle missing blockNumber")
- }
- timeoutMS := int64(5000)
- if args.Timeout != nil {
- timeoutMS = *args.Timeout
- }
- timeout := time.Millisecond * time.Duration(timeoutMS)
- state, parent, err := s.b.StateAndHeaderByNumberOrHash(ctx, args.StateBlockNumberOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- blockNumber := big.NewInt(int64(args.BlockNumber))
- timestamp := parent.Time + 1
- if args.Timestamp != nil {
- timestamp = *args.Timestamp
- }
- coinbase := parent.Coinbase
- if args.Coinbase != nil {
- coinbase = common.HexToAddress(*args.Coinbase)
- }
- header := &types.Header{
- ParentHash: parent.Hash(),
- Number: blockNumber,
- GasLimit: parent.GasLimit,
- Time: timestamp,
- Difficulty: parent.Difficulty,
- Coinbase: coinbase,
- BaseFee: parent.BaseFee,
- }
- // Setup context so it may be cancelled when the call
- // has completed or, in case of unmetered gas, setup
- // a context with a timeout
- var cancel context.CancelFunc
- if timeout > 0 {
- ctx, cancel = context.WithTimeout(ctx, timeout)
- } else {
- ctx, cancel = context.WithCancel(ctx)
- }
- // Make sure the context is cancelled when the call has completed
- // This makes sure resources are cleaned up
- defer cancel()
- // RPC Call gas cap
- globalGasCap := s.b.RPCGasCap()
- // Results
- results := []map[string]interface{}{}
- // Copy the original db so we don't modify it
- statedb := state.Copy()
- // Gas pool
- gp := new(core.GasPool).AddGas(math.MaxUint64)
- // Block context
- blockContext := core.NewEVMBlockContext(header, s.chain, &coinbase)
- // Feed each of the transactions into the VM ctx
- // And try and estimate the gas used
- for i, txArgs := range args.Txs {
- // Since its a txCall we'll just prepare the
- // state with a random hash
- var randomHash common.Hash
- rand.Read(randomHash[:])
- // New random hash since its a call
- statedb.Prepare(randomHash, i)
- // Convert tx args to msg to apply state transition
- msg, err := txArgs.ToMessage(globalGasCap, header.BaseFee)
- if err != nil {
- return nil, err
- }
- // Prepare the hashes
- txContext := core.NewEVMTxContext(msg)
- // Get EVM Environment
- vmenv := vm.NewEVM(blockContext, txContext, statedb, s.b.ChainConfig(), vm.Config{NoBaseFee: true})
- // Apply state transition
- result, err := core.ApplyMessage(vmenv, msg, gp)
- if err != nil {
- return nil, err
- }
- // Modifications are committed to the state
- // Only delete empty objects if EIP158/161 (a.k.a Spurious Dragon) is in effect
- statedb.Finalise(vmenv.ChainConfig().IsEIP158(blockNumber))
- // Append result
- jsonResult := map[string]interface{}{
- "gasUsed": result.UsedGas,
- }
- results = append(results, jsonResult)
- }
- // Return results
- ret := map[string]interface{}{}
- ret["results"] = results
- return ret, nil
- }
|