api.go 91 KB

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