api.go 52 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478
  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. "strings"
  24. "time"
  25. "github.com/ethereum/go-ethereum/accounts"
  26. "github.com/ethereum/go-ethereum/accounts/keystore"
  27. "github.com/ethereum/go-ethereum/common"
  28. "github.com/ethereum/go-ethereum/common/hexutil"
  29. "github.com/ethereum/go-ethereum/common/math"
  30. "github.com/ethereum/go-ethereum/consensus/ethash"
  31. "github.com/ethereum/go-ethereum/core"
  32. "github.com/ethereum/go-ethereum/core/types"
  33. "github.com/ethereum/go-ethereum/core/vm"
  34. "github.com/ethereum/go-ethereum/crypto"
  35. "github.com/ethereum/go-ethereum/log"
  36. "github.com/ethereum/go-ethereum/p2p"
  37. "github.com/ethereum/go-ethereum/params"
  38. "github.com/ethereum/go-ethereum/rlp"
  39. "github.com/ethereum/go-ethereum/rpc"
  40. "github.com/syndtr/goleveldb/leveldb"
  41. "github.com/syndtr/goleveldb/leveldb/util"
  42. )
  43. const (
  44. defaultGasPrice = 50 * params.Shannon
  45. )
  46. // PublicEthereumAPI provides an API to access Ethereum related information.
  47. // It offers only methods that operate on public data that is freely available to anyone.
  48. type PublicEthereumAPI struct {
  49. b Backend
  50. }
  51. // NewPublicEthereumAPI creates a new Ethereum protocol API.
  52. func NewPublicEthereumAPI(b Backend) *PublicEthereumAPI {
  53. return &PublicEthereumAPI{b}
  54. }
  55. // GasPrice returns a suggestion for a gas price.
  56. func (s *PublicEthereumAPI) GasPrice(ctx context.Context) (*big.Int, error) {
  57. return s.b.SuggestPrice(ctx)
  58. }
  59. // ProtocolVersion returns the current Ethereum protocol version this node supports
  60. func (s *PublicEthereumAPI) ProtocolVersion() hexutil.Uint {
  61. return hexutil.Uint(s.b.ProtocolVersion())
  62. }
  63. // Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not
  64. // yet received the latest block headers from its pears. In case it is synchronizing:
  65. // - startingBlock: block number this node started to synchronise from
  66. // - currentBlock: block number this node is currently importing
  67. // - highestBlock: block number of the highest block header this node has received from peers
  68. // - pulledStates: number of state entries processed until now
  69. // - knownStates: number of known state entries that still need to be pulled
  70. func (s *PublicEthereumAPI) Syncing() (interface{}, error) {
  71. progress := s.b.Downloader().Progress()
  72. // Return not syncing if the synchronisation already completed
  73. if progress.CurrentBlock >= progress.HighestBlock {
  74. return false, nil
  75. }
  76. // Otherwise gather the block sync stats
  77. return map[string]interface{}{
  78. "startingBlock": hexutil.Uint64(progress.StartingBlock),
  79. "currentBlock": hexutil.Uint64(progress.CurrentBlock),
  80. "highestBlock": hexutil.Uint64(progress.HighestBlock),
  81. "pulledStates": hexutil.Uint64(progress.PulledStates),
  82. "knownStates": hexutil.Uint64(progress.KnownStates),
  83. }, nil
  84. }
  85. // PublicTxPoolAPI offers and API for the transaction pool. It only operates on data that is non confidential.
  86. type PublicTxPoolAPI struct {
  87. b Backend
  88. }
  89. // NewPublicTxPoolAPI creates a new tx pool service that gives information about the transaction pool.
  90. func NewPublicTxPoolAPI(b Backend) *PublicTxPoolAPI {
  91. return &PublicTxPoolAPI{b}
  92. }
  93. // Content returns the transactions contained within the transaction pool.
  94. func (s *PublicTxPoolAPI) Content() map[string]map[string]map[string]*RPCTransaction {
  95. content := map[string]map[string]map[string]*RPCTransaction{
  96. "pending": make(map[string]map[string]*RPCTransaction),
  97. "queued": make(map[string]map[string]*RPCTransaction),
  98. }
  99. pending, queue := s.b.TxPoolContent()
  100. // Flatten the pending transactions
  101. for account, txs := range pending {
  102. dump := make(map[string]*RPCTransaction)
  103. for _, tx := range txs {
  104. dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx)
  105. }
  106. content["pending"][account.Hex()] = dump
  107. }
  108. // Flatten the queued transactions
  109. for account, txs := range queue {
  110. dump := make(map[string]*RPCTransaction)
  111. for _, tx := range txs {
  112. dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx)
  113. }
  114. content["queued"][account.Hex()] = dump
  115. }
  116. return content
  117. }
  118. // Status returns the number of pending and queued transaction in the pool.
  119. func (s *PublicTxPoolAPI) Status() map[string]hexutil.Uint {
  120. pending, queue := s.b.Stats()
  121. return map[string]hexutil.Uint{
  122. "pending": hexutil.Uint(pending),
  123. "queued": hexutil.Uint(queue),
  124. }
  125. }
  126. // Inspect retrieves the content of the transaction pool and flattens it into an
  127. // easily inspectable list.
  128. func (s *PublicTxPoolAPI) Inspect() map[string]map[string]map[string]string {
  129. content := map[string]map[string]map[string]string{
  130. "pending": make(map[string]map[string]string),
  131. "queued": make(map[string]map[string]string),
  132. }
  133. pending, queue := s.b.TxPoolContent()
  134. // Define a formatter to flatten a transaction into a string
  135. var format = func(tx *types.Transaction) string {
  136. if to := tx.To(); to != nil {
  137. return fmt.Sprintf("%s: %v wei + %v gas × %v wei", tx.To().Hex(), tx.Value(), tx.Gas(), tx.GasPrice())
  138. }
  139. return fmt.Sprintf("contract creation: %v wei + %v gas × %v wei", tx.Value(), tx.Gas(), tx.GasPrice())
  140. }
  141. // Flatten the pending transactions
  142. for account, txs := range pending {
  143. dump := make(map[string]string)
  144. for _, tx := range txs {
  145. dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx)
  146. }
  147. content["pending"][account.Hex()] = dump
  148. }
  149. // Flatten the queued transactions
  150. for account, txs := range queue {
  151. dump := make(map[string]string)
  152. for _, tx := range txs {
  153. dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx)
  154. }
  155. content["queued"][account.Hex()] = dump
  156. }
  157. return content
  158. }
  159. // PublicAccountAPI provides an API to access accounts managed by this node.
  160. // It offers only methods that can retrieve accounts.
  161. type PublicAccountAPI struct {
  162. am *accounts.Manager
  163. }
  164. // NewPublicAccountAPI creates a new PublicAccountAPI.
  165. func NewPublicAccountAPI(am *accounts.Manager) *PublicAccountAPI {
  166. return &PublicAccountAPI{am: am}
  167. }
  168. // Accounts returns the collection of accounts this node manages
  169. func (s *PublicAccountAPI) Accounts() []common.Address {
  170. addresses := make([]common.Address, 0) // return [] instead of nil if empty
  171. for _, wallet := range s.am.Wallets() {
  172. for _, account := range wallet.Accounts() {
  173. addresses = append(addresses, account.Address)
  174. }
  175. }
  176. return addresses
  177. }
  178. // PrivateAccountAPI provides an API to access accounts managed by this node.
  179. // It offers methods to create, (un)lock en list accounts. Some methods accept
  180. // passwords and are therefore considered private by default.
  181. type PrivateAccountAPI struct {
  182. am *accounts.Manager
  183. nonceLock *AddrLocker
  184. b Backend
  185. }
  186. // NewPrivateAccountAPI create a new PrivateAccountAPI.
  187. func NewPrivateAccountAPI(b Backend, nonceLock *AddrLocker) *PrivateAccountAPI {
  188. return &PrivateAccountAPI{
  189. am: b.AccountManager(),
  190. nonceLock: nonceLock,
  191. b: b,
  192. }
  193. }
  194. // ListAccounts will return a list of addresses for accounts this node manages.
  195. func (s *PrivateAccountAPI) ListAccounts() []common.Address {
  196. addresses := make([]common.Address, 0) // return [] instead of nil if empty
  197. for _, wallet := range s.am.Wallets() {
  198. for _, account := range wallet.Accounts() {
  199. addresses = append(addresses, account.Address)
  200. }
  201. }
  202. return addresses
  203. }
  204. // rawWallet is a JSON representation of an accounts.Wallet interface, with its
  205. // data contents extracted into plain fields.
  206. type rawWallet struct {
  207. URL string `json:"url"`
  208. Status string `json:"status"`
  209. Failure string `json:"failure,omitempty"`
  210. Accounts []accounts.Account `json:"accounts,omitempty"`
  211. }
  212. // ListWallets will return a list of wallets this node manages.
  213. func (s *PrivateAccountAPI) ListWallets() []rawWallet {
  214. wallets := make([]rawWallet, 0) // return [] instead of nil if empty
  215. for _, wallet := range s.am.Wallets() {
  216. status, failure := wallet.Status()
  217. raw := rawWallet{
  218. URL: wallet.URL().String(),
  219. Status: status,
  220. Accounts: wallet.Accounts(),
  221. }
  222. if failure != nil {
  223. raw.Failure = failure.Error()
  224. }
  225. wallets = append(wallets, raw)
  226. }
  227. return wallets
  228. }
  229. // OpenWallet initiates a hardware wallet opening procedure, establishing a USB
  230. // connection and attempting to authenticate via the provided passphrase. Note,
  231. // the method may return an extra challenge requiring a second open (e.g. the
  232. // Trezor PIN matrix challenge).
  233. func (s *PrivateAccountAPI) OpenWallet(url string, passphrase *string) error {
  234. wallet, err := s.am.Wallet(url)
  235. if err != nil {
  236. return err
  237. }
  238. pass := ""
  239. if passphrase != nil {
  240. pass = *passphrase
  241. }
  242. return wallet.Open(pass)
  243. }
  244. // DeriveAccount requests a HD wallet to derive a new account, optionally pinning
  245. // it for later reuse.
  246. func (s *PrivateAccountAPI) DeriveAccount(url string, path string, pin *bool) (accounts.Account, error) {
  247. wallet, err := s.am.Wallet(url)
  248. if err != nil {
  249. return accounts.Account{}, err
  250. }
  251. derivPath, err := accounts.ParseDerivationPath(path)
  252. if err != nil {
  253. return accounts.Account{}, err
  254. }
  255. if pin == nil {
  256. pin = new(bool)
  257. }
  258. return wallet.Derive(derivPath, *pin)
  259. }
  260. // NewAccount will create a new account and returns the address for the new account.
  261. func (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) {
  262. acc, err := fetchKeystore(s.am).NewAccount(password)
  263. if err == nil {
  264. return acc.Address, nil
  265. }
  266. return common.Address{}, err
  267. }
  268. // fetchKeystore retrives the encrypted keystore from the account manager.
  269. func fetchKeystore(am *accounts.Manager) *keystore.KeyStore {
  270. return am.Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
  271. }
  272. // ImportRawKey stores the given hex encoded ECDSA key into the key directory,
  273. // encrypting it with the passphrase.
  274. func (s *PrivateAccountAPI) ImportRawKey(privkey string, password string) (common.Address, error) {
  275. key, err := crypto.HexToECDSA(privkey)
  276. if err != nil {
  277. return common.Address{}, err
  278. }
  279. acc, err := fetchKeystore(s.am).ImportECDSA(key, password)
  280. return acc.Address, err
  281. }
  282. // UnlockAccount will unlock the account associated with the given address with
  283. // the given password for duration seconds. If duration is nil it will use a
  284. // default of 300 seconds. It returns an indication if the account was unlocked.
  285. func (s *PrivateAccountAPI) UnlockAccount(addr common.Address, password string, duration *uint64) (bool, error) {
  286. const max = uint64(time.Duration(math.MaxInt64) / time.Second)
  287. var d time.Duration
  288. if duration == nil {
  289. d = 300 * time.Second
  290. } else if *duration > max {
  291. return false, errors.New("unlock duration too large")
  292. } else {
  293. d = time.Duration(*duration) * time.Second
  294. }
  295. err := fetchKeystore(s.am).TimedUnlock(accounts.Account{Address: addr}, password, d)
  296. return err == nil, err
  297. }
  298. // LockAccount will lock the account associated with the given address when it's unlocked.
  299. func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool {
  300. return fetchKeystore(s.am).Lock(addr) == nil
  301. }
  302. // signTransactions sets defaults and signs the given transaction
  303. // NOTE: the caller needs to ensure that the nonceLock is held, if applicable,
  304. // and release it after the transaction has been submitted to the tx pool
  305. func (s *PrivateAccountAPI) signTransaction(ctx context.Context, args SendTxArgs, passwd string) (*types.Transaction, error) {
  306. // Look up the wallet containing the requested signer
  307. account := accounts.Account{Address: args.From}
  308. wallet, err := s.am.Find(account)
  309. if err != nil {
  310. return nil, err
  311. }
  312. // Set some sanity defaults and terminate on failure
  313. if err := args.setDefaults(ctx, s.b); err != nil {
  314. return nil, err
  315. }
  316. // Assemble the transaction and sign with the wallet
  317. tx := args.toTransaction()
  318. var chainID *big.Int
  319. if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
  320. chainID = config.ChainId
  321. }
  322. return wallet.SignTxWithPassphrase(account, passwd, tx, chainID)
  323. }
  324. // SendTransaction will create a transaction from the given arguments and
  325. // tries to sign it with the key associated with args.To. If the given passwd isn't
  326. // able to decrypt the key it fails.
  327. func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
  328. if args.Nonce == nil {
  329. // Hold the addresse's mutex around signing to prevent concurrent assignment of
  330. // the same nonce to multiple accounts.
  331. s.nonceLock.LockAddr(args.From)
  332. defer s.nonceLock.UnlockAddr(args.From)
  333. }
  334. signed, err := s.signTransaction(ctx, args, passwd)
  335. if err != nil {
  336. return common.Hash{}, err
  337. }
  338. return submitTransaction(ctx, s.b, signed)
  339. }
  340. // SignTransaction will create a transaction from the given arguments and
  341. // tries to sign it with the key associated with args.To. If the given passwd isn't
  342. // able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast
  343. // to other nodes
  344. func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args SendTxArgs, passwd string) (*SignTransactionResult, error) {
  345. // No need to obtain the noncelock mutex, since we won't be sending this
  346. // tx into the transaction pool, but right back to the user
  347. if args.Gas == nil {
  348. return nil, fmt.Errorf("gas not specified")
  349. }
  350. if args.GasPrice == nil {
  351. return nil, fmt.Errorf("gasPrice not specified")
  352. }
  353. if args.Nonce == nil {
  354. return nil, fmt.Errorf("nonce not specified")
  355. }
  356. signed, err := s.signTransaction(ctx, args, passwd)
  357. if err != nil {
  358. return nil, err
  359. }
  360. data, err := rlp.EncodeToBytes(signed)
  361. if err != nil {
  362. return nil, err
  363. }
  364. return &SignTransactionResult{data, signed}, nil
  365. }
  366. // signHash is a helper function that calculates a hash for the given message that can be
  367. // safely used to calculate a signature from.
  368. //
  369. // The hash is calulcated as
  370. // keccak256("\x19Ethereum Signed Message:\n"${message length}${message}).
  371. //
  372. // This gives context to the signed message and prevents signing of transactions.
  373. func signHash(data []byte) []byte {
  374. msg := fmt.Sprintf("\x19Ethereum Signed Message:\n%d%s", len(data), data)
  375. return crypto.Keccak256([]byte(msg))
  376. }
  377. // Sign calculates an Ethereum ECDSA signature for:
  378. // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message))
  379. //
  380. // Note, the produced signature conforms to the secp256k1 curve R, S and V values,
  381. // where the V value will be 27 or 28 for legacy reasons.
  382. //
  383. // The key used to calculate the signature is decrypted with the given password.
  384. //
  385. // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign
  386. func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {
  387. // Look up the wallet containing the requested signer
  388. account := accounts.Account{Address: addr}
  389. wallet, err := s.b.AccountManager().Find(account)
  390. if err != nil {
  391. return nil, err
  392. }
  393. // Assemble sign the data with the wallet
  394. signature, err := wallet.SignHashWithPassphrase(account, passwd, signHash(data))
  395. if err != nil {
  396. return nil, err
  397. }
  398. signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
  399. return signature, nil
  400. }
  401. // EcRecover returns the address for the account that was used to create the signature.
  402. // Note, this function is compatible with eth_sign and personal_sign. As such it recovers
  403. // the address of:
  404. // hash = keccak256("\x19Ethereum Signed Message:\n"${message length}${message})
  405. // addr = ecrecover(hash, signature)
  406. //
  407. // Note, the signature must conform to the secp256k1 curve R, S and V values, where
  408. // the V value must be be 27 or 28 for legacy reasons.
  409. //
  410. // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover
  411. func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {
  412. if len(sig) != 65 {
  413. return common.Address{}, fmt.Errorf("signature must be 65 bytes long")
  414. }
  415. if sig[64] != 27 && sig[64] != 28 {
  416. return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)")
  417. }
  418. sig[64] -= 27 // Transform yellow paper V from 27/28 to 0/1
  419. rpk, err := crypto.Ecrecover(signHash(data), sig)
  420. if err != nil {
  421. return common.Address{}, err
  422. }
  423. pubKey := crypto.ToECDSAPub(rpk)
  424. recoveredAddr := crypto.PubkeyToAddress(*pubKey)
  425. return recoveredAddr, nil
  426. }
  427. // SignAndSendTransaction was renamed to SendTransaction. This method is deprecated
  428. // and will be removed in the future. It primary goal is to give clients time to update.
  429. func (s *PrivateAccountAPI) SignAndSendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
  430. return s.SendTransaction(ctx, args, passwd)
  431. }
  432. // PublicBlockChainAPI provides an API to access the Ethereum blockchain.
  433. // It offers only methods that operate on public data that is freely available to anyone.
  434. type PublicBlockChainAPI struct {
  435. b Backend
  436. }
  437. // NewPublicBlockChainAPI creates a new Ethereum blockchain API.
  438. func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI {
  439. return &PublicBlockChainAPI{b}
  440. }
  441. // BlockNumber returns the block number of the chain head.
  442. func (s *PublicBlockChainAPI) BlockNumber() *big.Int {
  443. header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available
  444. return header.Number
  445. }
  446. // GetBalance returns the amount of wei for the given address in the state of the
  447. // given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta
  448. // block numbers are also allowed.
  449. func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*big.Int, error) {
  450. state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
  451. if state == nil || err != nil {
  452. return nil, err
  453. }
  454. b := state.GetBalance(address)
  455. return b, state.Error()
  456. }
  457. // GetBlockByNumber returns the requested block. When blockNr is -1 the chain head is returned. When fullTx is true all
  458. // transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
  459. func (s *PublicBlockChainAPI) GetBlockByNumber(ctx context.Context, blockNr rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) {
  460. block, err := s.b.BlockByNumber(ctx, blockNr)
  461. if block != nil {
  462. response, err := s.rpcOutputBlock(block, true, fullTx)
  463. if err == nil && blockNr == rpc.PendingBlockNumber {
  464. // Pending blocks need to nil out a few fields
  465. for _, field := range []string{"hash", "nonce", "miner"} {
  466. response[field] = nil
  467. }
  468. }
  469. return response, err
  470. }
  471. return nil, err
  472. }
  473. // GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full
  474. // detail, otherwise only the transaction hash is returned.
  475. func (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, blockHash common.Hash, fullTx bool) (map[string]interface{}, error) {
  476. block, err := s.b.GetBlock(ctx, blockHash)
  477. if block != nil {
  478. return s.rpcOutputBlock(block, true, fullTx)
  479. }
  480. return nil, err
  481. }
  482. // GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true
  483. // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
  484. func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {
  485. block, err := s.b.BlockByNumber(ctx, blockNr)
  486. if block != nil {
  487. uncles := block.Uncles()
  488. if index >= hexutil.Uint(len(uncles)) {
  489. log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index)
  490. return nil, nil
  491. }
  492. block = types.NewBlockWithHeader(uncles[index])
  493. return s.rpcOutputBlock(block, false, false)
  494. }
  495. return nil, err
  496. }
  497. // GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true
  498. // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
  499. func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {
  500. block, err := s.b.GetBlock(ctx, blockHash)
  501. if block != nil {
  502. uncles := block.Uncles()
  503. if index >= hexutil.Uint(len(uncles)) {
  504. log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index)
  505. return nil, nil
  506. }
  507. block = types.NewBlockWithHeader(uncles[index])
  508. return s.rpcOutputBlock(block, false, false)
  509. }
  510. return nil, err
  511. }
  512. // GetUncleCountByBlockNumber returns number of uncles in the block for the given block number
  513. func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
  514. if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
  515. n := hexutil.Uint(len(block.Uncles()))
  516. return &n
  517. }
  518. return nil
  519. }
  520. // GetUncleCountByBlockHash returns number of uncles in the block for the given block hash
  521. func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
  522. if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
  523. n := hexutil.Uint(len(block.Uncles()))
  524. return &n
  525. }
  526. return nil
  527. }
  528. // GetCode returns the code stored at the given address in the state for the given block number.
  529. func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
  530. state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
  531. if state == nil || err != nil {
  532. return nil, err
  533. }
  534. code := state.GetCode(address)
  535. return code, state.Error()
  536. }
  537. // GetStorageAt returns the storage from the state at the given address, key and
  538. // block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block
  539. // numbers are also allowed.
  540. func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
  541. state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
  542. if state == nil || err != nil {
  543. return nil, err
  544. }
  545. res := state.GetState(address, common.HexToHash(key))
  546. return res[:], state.Error()
  547. }
  548. // CallArgs represents the arguments for a call.
  549. type CallArgs struct {
  550. From common.Address `json:"from"`
  551. To *common.Address `json:"to"`
  552. Gas hexutil.Uint64 `json:"gas"`
  553. GasPrice hexutil.Big `json:"gasPrice"`
  554. Value hexutil.Big `json:"value"`
  555. Data hexutil.Bytes `json:"data"`
  556. }
  557. func (s *PublicBlockChainAPI) doCall(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber, vmCfg vm.Config) ([]byte, uint64, bool, error) {
  558. defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now())
  559. state, header, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
  560. if state == nil || err != nil {
  561. return nil, 0, false, err
  562. }
  563. // Set sender address or use a default if none specified
  564. addr := args.From
  565. if addr == (common.Address{}) {
  566. if wallets := s.b.AccountManager().Wallets(); len(wallets) > 0 {
  567. if accounts := wallets[0].Accounts(); len(accounts) > 0 {
  568. addr = accounts[0].Address
  569. }
  570. }
  571. }
  572. // Set default gas & gas price if none were set
  573. gas, gasPrice := uint64(args.Gas), args.GasPrice.ToInt()
  574. if gas == 0 {
  575. gas = 50000000
  576. }
  577. if gasPrice.Sign() == 0 {
  578. gasPrice = new(big.Int).SetUint64(defaultGasPrice)
  579. }
  580. // Create new call message
  581. msg := types.NewMessage(addr, args.To, 0, args.Value.ToInt(), gas, gasPrice, args.Data, false)
  582. // Setup context so it may be cancelled the call has completed
  583. // or, in case of unmetered gas, setup a context with a timeout.
  584. var cancel context.CancelFunc
  585. if vmCfg.DisableGasMetering {
  586. ctx, cancel = context.WithTimeout(ctx, time.Second*5)
  587. } else {
  588. ctx, cancel = context.WithCancel(ctx)
  589. }
  590. // Make sure the context is cancelled when the call has completed
  591. // this makes sure resources are cleaned up.
  592. defer func() { cancel() }()
  593. // Get a new instance of the EVM.
  594. evm, vmError, err := s.b.GetEVM(ctx, msg, state, header, vmCfg)
  595. if err != nil {
  596. return nil, 0, false, err
  597. }
  598. // Wait for the context to be done and cancel the evm. Even if the
  599. // EVM has finished, cancelling may be done (repeatedly)
  600. go func() {
  601. <-ctx.Done()
  602. evm.Cancel()
  603. }()
  604. // Setup the gas pool (also for unmetered requests)
  605. // and apply the message.
  606. gp := new(core.GasPool).AddGas(math.MaxUint64)
  607. res, gas, failed, err := core.ApplyMessage(evm, msg, gp)
  608. if err := vmError(); err != nil {
  609. return nil, 0, false, err
  610. }
  611. return res, gas, failed, err
  612. }
  613. // Call executes the given transaction on the state for the given block number.
  614. // It doesn't make and changes in the state/blockchain and is useful to execute and retrieve values.
  615. func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
  616. result, _, _, err := s.doCall(ctx, args, blockNr, vm.Config{DisableGasMetering: true})
  617. return (hexutil.Bytes)(result), err
  618. }
  619. // EstimateGas returns an estimate of the amount of gas needed to execute the
  620. // given transaction against the current pending block.
  621. func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (hexutil.Uint64, error) {
  622. // Binary search the gas requirement, as it may be higher than the amount used
  623. var (
  624. lo uint64 = params.TxGas - 1
  625. hi uint64
  626. cap uint64
  627. )
  628. if uint64(args.Gas) >= params.TxGas {
  629. hi = uint64(args.Gas)
  630. } else {
  631. // Retrieve the current pending block to act as the gas ceiling
  632. block, err := s.b.BlockByNumber(ctx, rpc.PendingBlockNumber)
  633. if err != nil {
  634. return 0, err
  635. }
  636. hi = block.GasLimit()
  637. }
  638. cap = hi
  639. // Create a helper to check if a gas allowance results in an executable transaction
  640. executable := func(gas uint64) bool {
  641. args.Gas = hexutil.Uint64(gas)
  642. _, _, failed, err := s.doCall(ctx, args, rpc.PendingBlockNumber, vm.Config{})
  643. if err != nil || failed {
  644. return false
  645. }
  646. return true
  647. }
  648. // Execute the binary search and hone in on an executable gas limit
  649. for lo+1 < hi {
  650. mid := (hi + lo) / 2
  651. if !executable(mid) {
  652. lo = mid
  653. } else {
  654. hi = mid
  655. }
  656. }
  657. // Reject the transaction as invalid if it still fails at the highest allowance
  658. if hi == cap {
  659. if !executable(hi) {
  660. return 0, fmt.Errorf("gas required exceeds allowance or always failing transaction")
  661. }
  662. }
  663. return hexutil.Uint64(hi), nil
  664. }
  665. // ExecutionResult groups all structured logs emitted by the EVM
  666. // while replaying a transaction in debug mode as well as transaction
  667. // execution status, the amount of gas used and the return value
  668. type ExecutionResult struct {
  669. Gas uint64 `json:"gas"`
  670. Failed bool `json:"failed"`
  671. ReturnValue string `json:"returnValue"`
  672. StructLogs []StructLogRes `json:"structLogs"`
  673. }
  674. // StructLogRes stores a structured log emitted by the EVM while replaying a
  675. // transaction in debug mode
  676. type StructLogRes struct {
  677. Pc uint64 `json:"pc"`
  678. Op string `json:"op"`
  679. Gas uint64 `json:"gas"`
  680. GasCost uint64 `json:"gasCost"`
  681. Depth int `json:"depth"`
  682. Error error `json:"error,omitempty"`
  683. Stack *[]string `json:"stack,omitempty"`
  684. Memory *[]string `json:"memory,omitempty"`
  685. Storage *map[string]string `json:"storage,omitempty"`
  686. }
  687. // formatLogs formats EVM returned structured logs for json output
  688. func FormatLogs(logs []vm.StructLog) []StructLogRes {
  689. formatted := make([]StructLogRes, len(logs))
  690. for index, trace := range logs {
  691. formatted[index] = StructLogRes{
  692. Pc: trace.Pc,
  693. Op: trace.Op.String(),
  694. Gas: trace.Gas,
  695. GasCost: trace.GasCost,
  696. Depth: trace.Depth,
  697. Error: trace.Err,
  698. }
  699. if trace.Stack != nil {
  700. stack := make([]string, len(trace.Stack))
  701. for i, stackValue := range trace.Stack {
  702. stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32))
  703. }
  704. formatted[index].Stack = &stack
  705. }
  706. if trace.Memory != nil {
  707. memory := make([]string, 0, (len(trace.Memory)+31)/32)
  708. for i := 0; i+32 <= len(trace.Memory); i += 32 {
  709. memory = append(memory, fmt.Sprintf("%x", trace.Memory[i:i+32]))
  710. }
  711. formatted[index].Memory = &memory
  712. }
  713. if trace.Storage != nil {
  714. storage := make(map[string]string)
  715. for i, storageValue := range trace.Storage {
  716. storage[fmt.Sprintf("%x", i)] = fmt.Sprintf("%x", storageValue)
  717. }
  718. formatted[index].Storage = &storage
  719. }
  720. }
  721. return formatted
  722. }
  723. // rpcOutputBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are
  724. // returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain
  725. // transaction hashes.
  726. func (s *PublicBlockChainAPI) rpcOutputBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
  727. head := b.Header() // copies the header once
  728. fields := map[string]interface{}{
  729. "number": (*hexutil.Big)(head.Number),
  730. "hash": b.Hash(),
  731. "parentHash": head.ParentHash,
  732. "nonce": head.Nonce,
  733. "mixHash": head.MixDigest,
  734. "sha3Uncles": head.UncleHash,
  735. "logsBloom": head.Bloom,
  736. "stateRoot": head.Root,
  737. "miner": head.Coinbase,
  738. "difficulty": (*hexutil.Big)(head.Difficulty),
  739. "totalDifficulty": (*hexutil.Big)(s.b.GetTd(b.Hash())),
  740. "extraData": hexutil.Bytes(head.Extra),
  741. "size": hexutil.Uint64(b.Size()),
  742. "gasLimit": hexutil.Uint64(head.GasLimit),
  743. "gasUsed": hexutil.Uint64(head.GasUsed),
  744. "timestamp": (*hexutil.Big)(head.Time),
  745. "transactionsRoot": head.TxHash,
  746. "receiptsRoot": head.ReceiptHash,
  747. }
  748. if inclTx {
  749. formatTx := func(tx *types.Transaction) (interface{}, error) {
  750. return tx.Hash(), nil
  751. }
  752. if fullTx {
  753. formatTx = func(tx *types.Transaction) (interface{}, error) {
  754. return newRPCTransactionFromBlockHash(b, tx.Hash()), nil
  755. }
  756. }
  757. txs := b.Transactions()
  758. transactions := make([]interface{}, len(txs))
  759. var err error
  760. for i, tx := range b.Transactions() {
  761. if transactions[i], err = formatTx(tx); err != nil {
  762. return nil, err
  763. }
  764. }
  765. fields["transactions"] = transactions
  766. }
  767. uncles := b.Uncles()
  768. uncleHashes := make([]common.Hash, len(uncles))
  769. for i, uncle := range uncles {
  770. uncleHashes[i] = uncle.Hash()
  771. }
  772. fields["uncles"] = uncleHashes
  773. return fields, nil
  774. }
  775. // RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction
  776. type RPCTransaction struct {
  777. BlockHash common.Hash `json:"blockHash"`
  778. BlockNumber *hexutil.Big `json:"blockNumber"`
  779. From common.Address `json:"from"`
  780. Gas hexutil.Uint64 `json:"gas"`
  781. GasPrice *hexutil.Big `json:"gasPrice"`
  782. Hash common.Hash `json:"hash"`
  783. Input hexutil.Bytes `json:"input"`
  784. Nonce hexutil.Uint64 `json:"nonce"`
  785. To *common.Address `json:"to"`
  786. TransactionIndex hexutil.Uint `json:"transactionIndex"`
  787. Value *hexutil.Big `json:"value"`
  788. V *hexutil.Big `json:"v"`
  789. R *hexutil.Big `json:"r"`
  790. S *hexutil.Big `json:"s"`
  791. }
  792. // newRPCTransaction returns a transaction that will serialize to the RPC
  793. // representation, with the given location metadata set (if available).
  794. func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64) *RPCTransaction {
  795. var signer types.Signer = types.FrontierSigner{}
  796. if tx.Protected() {
  797. signer = types.NewEIP155Signer(tx.ChainId())
  798. }
  799. from, _ := types.Sender(signer, tx)
  800. v, r, s := tx.RawSignatureValues()
  801. result := &RPCTransaction{
  802. From: from,
  803. Gas: hexutil.Uint64(tx.Gas()),
  804. GasPrice: (*hexutil.Big)(tx.GasPrice()),
  805. Hash: tx.Hash(),
  806. Input: hexutil.Bytes(tx.Data()),
  807. Nonce: hexutil.Uint64(tx.Nonce()),
  808. To: tx.To(),
  809. Value: (*hexutil.Big)(tx.Value()),
  810. V: (*hexutil.Big)(v),
  811. R: (*hexutil.Big)(r),
  812. S: (*hexutil.Big)(s),
  813. }
  814. if blockHash != (common.Hash{}) {
  815. result.BlockHash = blockHash
  816. result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber))
  817. result.TransactionIndex = hexutil.Uint(index)
  818. }
  819. return result
  820. }
  821. // newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation
  822. func newRPCPendingTransaction(tx *types.Transaction) *RPCTransaction {
  823. return newRPCTransaction(tx, common.Hash{}, 0, 0)
  824. }
  825. // newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation.
  826. func newRPCTransactionFromBlockIndex(b *types.Block, index uint64) *RPCTransaction {
  827. txs := b.Transactions()
  828. if index >= uint64(len(txs)) {
  829. return nil
  830. }
  831. return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index)
  832. }
  833. // newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index.
  834. func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes {
  835. txs := b.Transactions()
  836. if index >= uint64(len(txs)) {
  837. return nil
  838. }
  839. blob, _ := rlp.EncodeToBytes(txs[index])
  840. return blob
  841. }
  842. // newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
  843. func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction {
  844. for idx, tx := range b.Transactions() {
  845. if tx.Hash() == hash {
  846. return newRPCTransactionFromBlockIndex(b, uint64(idx))
  847. }
  848. }
  849. return nil
  850. }
  851. // PublicTransactionPoolAPI exposes methods for the RPC interface
  852. type PublicTransactionPoolAPI struct {
  853. b Backend
  854. nonceLock *AddrLocker
  855. }
  856. // NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
  857. func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI {
  858. return &PublicTransactionPoolAPI{b, nonceLock}
  859. }
  860. // GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
  861. func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
  862. if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
  863. n := hexutil.Uint(len(block.Transactions()))
  864. return &n
  865. }
  866. return nil
  867. }
  868. // GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
  869. func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
  870. if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
  871. n := hexutil.Uint(len(block.Transactions()))
  872. return &n
  873. }
  874. return nil
  875. }
  876. // GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
  877. func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
  878. if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
  879. return newRPCTransactionFromBlockIndex(block, uint64(index))
  880. }
  881. return nil
  882. }
  883. // GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
  884. func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
  885. if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
  886. return newRPCTransactionFromBlockIndex(block, uint64(index))
  887. }
  888. return nil
  889. }
  890. // GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
  891. func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
  892. if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
  893. return newRPCRawTransactionFromBlockIndex(block, uint64(index))
  894. }
  895. return nil
  896. }
  897. // GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
  898. func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
  899. if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
  900. return newRPCRawTransactionFromBlockIndex(block, uint64(index))
  901. }
  902. return nil
  903. }
  904. // GetTransactionCount returns the number of transactions the given address has sent for the given block number
  905. func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) {
  906. state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
  907. if state == nil || err != nil {
  908. return nil, err
  909. }
  910. nonce := state.GetNonce(address)
  911. return (*hexutil.Uint64)(&nonce), state.Error()
  912. }
  913. // GetTransactionByHash returns the transaction for the given hash
  914. func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) *RPCTransaction {
  915. // Try to return an already finalized transaction
  916. if tx, blockHash, blockNumber, index := core.GetTransaction(s.b.ChainDb(), hash); tx != nil {
  917. return newRPCTransaction(tx, blockHash, blockNumber, index)
  918. }
  919. // No finalized transaction, try to retrieve it from the pool
  920. if tx := s.b.GetPoolTransaction(hash); tx != nil {
  921. return newRPCPendingTransaction(tx)
  922. }
  923. // Transaction unknown, return as such
  924. return nil
  925. }
  926. // GetRawTransactionByHash returns the bytes of the transaction for the given hash.
  927. func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
  928. var tx *types.Transaction
  929. // Retrieve a finalized transaction, or a pooled otherwise
  930. if tx, _, _, _ = core.GetTransaction(s.b.ChainDb(), hash); tx == nil {
  931. if tx = s.b.GetPoolTransaction(hash); tx == nil {
  932. // Transaction not found anywhere, abort
  933. return nil, nil
  934. }
  935. }
  936. // Serialize to RLP and return
  937. return rlp.EncodeToBytes(tx)
  938. }
  939. // GetTransactionReceipt returns the transaction receipt for the given transaction hash.
  940. func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {
  941. tx, blockHash, blockNumber, index := core.GetTransaction(s.b.ChainDb(), hash)
  942. if tx == nil {
  943. return nil, errors.New("unknown transaction")
  944. }
  945. receipts, err := s.b.GetReceipts(ctx, blockHash)
  946. if err != nil {
  947. return nil, err
  948. }
  949. if len(receipts) <= int(index) {
  950. return nil, errors.New("unknown receipt")
  951. }
  952. receipt := receipts[index]
  953. var signer types.Signer = types.FrontierSigner{}
  954. if tx.Protected() {
  955. signer = types.NewEIP155Signer(tx.ChainId())
  956. }
  957. from, _ := types.Sender(signer, tx)
  958. fields := map[string]interface{}{
  959. "blockHash": blockHash,
  960. "blockNumber": hexutil.Uint64(blockNumber),
  961. "transactionHash": hash,
  962. "transactionIndex": hexutil.Uint64(index),
  963. "from": from,
  964. "to": tx.To(),
  965. "gasUsed": hexutil.Uint64(receipt.GasUsed),
  966. "cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed),
  967. "contractAddress": nil,
  968. "logs": receipt.Logs,
  969. "logsBloom": receipt.Bloom,
  970. }
  971. // Assign receipt status or post state.
  972. if len(receipt.PostState) > 0 {
  973. fields["root"] = hexutil.Bytes(receipt.PostState)
  974. } else {
  975. fields["status"] = hexutil.Uint(receipt.Status)
  976. }
  977. if receipt.Logs == nil {
  978. fields["logs"] = [][]*types.Log{}
  979. }
  980. // If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
  981. if receipt.ContractAddress != (common.Address{}) {
  982. fields["contractAddress"] = receipt.ContractAddress
  983. }
  984. return fields, nil
  985. }
  986. // sign is a helper function that signs a transaction with the private key of the given address.
  987. func (s *PublicTransactionPoolAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) {
  988. // Look up the wallet containing the requested signer
  989. account := accounts.Account{Address: addr}
  990. wallet, err := s.b.AccountManager().Find(account)
  991. if err != nil {
  992. return nil, err
  993. }
  994. // Request the wallet to sign the transaction
  995. var chainID *big.Int
  996. if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
  997. chainID = config.ChainId
  998. }
  999. return wallet.SignTx(account, tx, chainID)
  1000. }
  1001. // SendTxArgs represents the arguments to sumbit a new transaction into the transaction pool.
  1002. type SendTxArgs struct {
  1003. From common.Address `json:"from"`
  1004. To *common.Address `json:"to"`
  1005. Gas *hexutil.Uint64 `json:"gas"`
  1006. GasPrice *hexutil.Big `json:"gasPrice"`
  1007. Value *hexutil.Big `json:"value"`
  1008. Nonce *hexutil.Uint64 `json:"nonce"`
  1009. // We accept "data" and "input" for backwards-compatibility reasons. "input" is the
  1010. // newer name and should be preferred by clients.
  1011. Data *hexutil.Bytes `json:"data"`
  1012. Input *hexutil.Bytes `json:"input"`
  1013. }
  1014. // setDefaults is a helper function that fills in default values for unspecified tx fields.
  1015. func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
  1016. if args.Gas == nil {
  1017. args.Gas = new(hexutil.Uint64)
  1018. *(*uint64)(args.Gas) = 90000
  1019. }
  1020. if args.GasPrice == nil {
  1021. price, err := b.SuggestPrice(ctx)
  1022. if err != nil {
  1023. return err
  1024. }
  1025. args.GasPrice = (*hexutil.Big)(price)
  1026. }
  1027. if args.Value == nil {
  1028. args.Value = new(hexutil.Big)
  1029. }
  1030. if args.Nonce == nil {
  1031. nonce, err := b.GetPoolNonce(ctx, args.From)
  1032. if err != nil {
  1033. return err
  1034. }
  1035. args.Nonce = (*hexutil.Uint64)(&nonce)
  1036. }
  1037. if args.Data != nil && args.Input != nil && !bytes.Equal(*args.Data, *args.Input) {
  1038. return errors.New(`Both "data" and "input" are set and not equal. Please use "input" to pass transaction call data.`)
  1039. }
  1040. if args.To == nil {
  1041. // Contract creation
  1042. var input []byte
  1043. if args.Data != nil {
  1044. input = *args.Data
  1045. } else if args.Input != nil {
  1046. input = *args.Input
  1047. }
  1048. if len(input) == 0 {
  1049. return errors.New(`contract creation without any data provided`)
  1050. }
  1051. }
  1052. return nil
  1053. }
  1054. func (args *SendTxArgs) toTransaction() *types.Transaction {
  1055. var input []byte
  1056. if args.Data != nil {
  1057. input = *args.Data
  1058. } else if args.Input != nil {
  1059. input = *args.Input
  1060. }
  1061. if args.To == nil {
  1062. return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
  1063. }
  1064. return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
  1065. }
  1066. // submitTransaction is a helper function that submits tx to txPool and logs a message.
  1067. func submitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) {
  1068. if err := b.SendTx(ctx, tx); err != nil {
  1069. return common.Hash{}, err
  1070. }
  1071. if tx.To() == nil {
  1072. signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
  1073. from, err := types.Sender(signer, tx)
  1074. if err != nil {
  1075. return common.Hash{}, err
  1076. }
  1077. addr := crypto.CreateAddress(from, tx.Nonce())
  1078. log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
  1079. } else {
  1080. log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
  1081. }
  1082. return tx.Hash(), nil
  1083. }
  1084. // SendTransaction creates a transaction for the given argument, sign it and submit it to the
  1085. // transaction pool.
  1086. func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args SendTxArgs) (common.Hash, error) {
  1087. // Look up the wallet containing the requested signer
  1088. account := accounts.Account{Address: args.From}
  1089. wallet, err := s.b.AccountManager().Find(account)
  1090. if err != nil {
  1091. return common.Hash{}, err
  1092. }
  1093. if args.Nonce == nil {
  1094. // Hold the addresse's mutex around signing to prevent concurrent assignment of
  1095. // the same nonce to multiple accounts.
  1096. s.nonceLock.LockAddr(args.From)
  1097. defer s.nonceLock.UnlockAddr(args.From)
  1098. }
  1099. // Set some sanity defaults and terminate on failure
  1100. if err := args.setDefaults(ctx, s.b); err != nil {
  1101. return common.Hash{}, err
  1102. }
  1103. // Assemble the transaction and sign with the wallet
  1104. tx := args.toTransaction()
  1105. var chainID *big.Int
  1106. if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
  1107. chainID = config.ChainId
  1108. }
  1109. signed, err := wallet.SignTx(account, tx, chainID)
  1110. if err != nil {
  1111. return common.Hash{}, err
  1112. }
  1113. return submitTransaction(ctx, s.b, signed)
  1114. }
  1115. // SendRawTransaction will add the signed transaction to the transaction pool.
  1116. // The sender is responsible for signing the transaction and using the correct nonce.
  1117. func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) {
  1118. tx := new(types.Transaction)
  1119. if err := rlp.DecodeBytes(encodedTx, tx); err != nil {
  1120. return common.Hash{}, err
  1121. }
  1122. return submitTransaction(ctx, s.b, tx)
  1123. }
  1124. // Sign calculates an ECDSA signature for:
  1125. // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
  1126. //
  1127. // Note, the produced signature conforms to the secp256k1 curve R, S and V values,
  1128. // where the V value will be 27 or 28 for legacy reasons.
  1129. //
  1130. // The account associated with addr must be unlocked.
  1131. //
  1132. // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
  1133. func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
  1134. // Look up the wallet containing the requested signer
  1135. account := accounts.Account{Address: addr}
  1136. wallet, err := s.b.AccountManager().Find(account)
  1137. if err != nil {
  1138. return nil, err
  1139. }
  1140. // Sign the requested hash with the wallet
  1141. signature, err := wallet.SignHash(account, signHash(data))
  1142. if err == nil {
  1143. signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
  1144. }
  1145. return signature, err
  1146. }
  1147. // SignTransactionResult represents a RLP encoded signed transaction.
  1148. type SignTransactionResult struct {
  1149. Raw hexutil.Bytes `json:"raw"`
  1150. Tx *types.Transaction `json:"tx"`
  1151. }
  1152. // SignTransaction will sign the given transaction with the from account.
  1153. // The node needs to have the private key of the account corresponding with
  1154. // the given from address and it needs to be unlocked.
  1155. func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
  1156. if args.Gas == nil {
  1157. return nil, fmt.Errorf("gas not specified")
  1158. }
  1159. if args.GasPrice == nil {
  1160. return nil, fmt.Errorf("gasPrice not specified")
  1161. }
  1162. if args.Nonce == nil {
  1163. return nil, fmt.Errorf("nonce not specified")
  1164. }
  1165. if err := args.setDefaults(ctx, s.b); err != nil {
  1166. return nil, err
  1167. }
  1168. tx, err := s.sign(args.From, args.toTransaction())
  1169. if err != nil {
  1170. return nil, err
  1171. }
  1172. data, err := rlp.EncodeToBytes(tx)
  1173. if err != nil {
  1174. return nil, err
  1175. }
  1176. return &SignTransactionResult{data, tx}, nil
  1177. }
  1178. // PendingTransactions returns the transactions that are in the transaction pool and have a from address that is one of
  1179. // the accounts this node manages.
  1180. func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
  1181. pending, err := s.b.GetPoolTransactions()
  1182. if err != nil {
  1183. return nil, err
  1184. }
  1185. transactions := make([]*RPCTransaction, 0, len(pending))
  1186. for _, tx := range pending {
  1187. var signer types.Signer = types.HomesteadSigner{}
  1188. if tx.Protected() {
  1189. signer = types.NewEIP155Signer(tx.ChainId())
  1190. }
  1191. from, _ := types.Sender(signer, tx)
  1192. if _, err := s.b.AccountManager().Find(accounts.Account{Address: from}); err == nil {
  1193. transactions = append(transactions, newRPCPendingTransaction(tx))
  1194. }
  1195. }
  1196. return transactions, nil
  1197. }
  1198. // Resend accepts an existing transaction and a new gas price and limit. It will remove
  1199. // the given transaction from the pool and reinsert it with the new gas price and limit.
  1200. func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {
  1201. if sendArgs.Nonce == nil {
  1202. return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec")
  1203. }
  1204. if err := sendArgs.setDefaults(ctx, s.b); err != nil {
  1205. return common.Hash{}, err
  1206. }
  1207. matchTx := sendArgs.toTransaction()
  1208. pending, err := s.b.GetPoolTransactions()
  1209. if err != nil {
  1210. return common.Hash{}, err
  1211. }
  1212. for _, p := range pending {
  1213. var signer types.Signer = types.HomesteadSigner{}
  1214. if p.Protected() {
  1215. signer = types.NewEIP155Signer(p.ChainId())
  1216. }
  1217. wantSigHash := signer.Hash(matchTx)
  1218. if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash {
  1219. // Match. Re-sign and send the transaction.
  1220. if gasPrice != nil {
  1221. sendArgs.GasPrice = gasPrice
  1222. }
  1223. if gasLimit != nil {
  1224. sendArgs.Gas = gasLimit
  1225. }
  1226. signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())
  1227. if err != nil {
  1228. return common.Hash{}, err
  1229. }
  1230. if err = s.b.SendTx(ctx, signedTx); err != nil {
  1231. return common.Hash{}, err
  1232. }
  1233. return signedTx.Hash(), nil
  1234. }
  1235. }
  1236. return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash())
  1237. }
  1238. // PublicDebugAPI is the collection of Ethereum APIs exposed over the public
  1239. // debugging endpoint.
  1240. type PublicDebugAPI struct {
  1241. b Backend
  1242. }
  1243. // NewPublicDebugAPI creates a new API definition for the public debug methods
  1244. // of the Ethereum service.
  1245. func NewPublicDebugAPI(b Backend) *PublicDebugAPI {
  1246. return &PublicDebugAPI{b: b}
  1247. }
  1248. // GetBlockRlp retrieves the RLP encoded for of a single block.
  1249. func (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) {
  1250. block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1251. if block == nil {
  1252. return "", fmt.Errorf("block #%d not found", number)
  1253. }
  1254. encoded, err := rlp.EncodeToBytes(block)
  1255. if err != nil {
  1256. return "", err
  1257. }
  1258. return fmt.Sprintf("%x", encoded), nil
  1259. }
  1260. // PrintBlock retrieves a block and returns its pretty printed form.
  1261. func (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) {
  1262. block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1263. if block == nil {
  1264. return "", fmt.Errorf("block #%d not found", number)
  1265. }
  1266. return block.String(), nil
  1267. }
  1268. // SeedHash retrieves the seed hash of a block.
  1269. func (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) {
  1270. block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1271. if block == nil {
  1272. return "", fmt.Errorf("block #%d not found", number)
  1273. }
  1274. return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil
  1275. }
  1276. // PrivateDebugAPI is the collection of Ethereum APIs exposed over the private
  1277. // debugging endpoint.
  1278. type PrivateDebugAPI struct {
  1279. b Backend
  1280. }
  1281. // NewPrivateDebugAPI creates a new API definition for the private debug methods
  1282. // of the Ethereum service.
  1283. func NewPrivateDebugAPI(b Backend) *PrivateDebugAPI {
  1284. return &PrivateDebugAPI{b: b}
  1285. }
  1286. // ChaindbProperty returns leveldb properties of the chain database.
  1287. func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) {
  1288. ldb, ok := api.b.ChainDb().(interface {
  1289. LDB() *leveldb.DB
  1290. })
  1291. if !ok {
  1292. return "", fmt.Errorf("chaindbProperty does not work for memory databases")
  1293. }
  1294. if property == "" {
  1295. property = "leveldb.stats"
  1296. } else if !strings.HasPrefix(property, "leveldb.") {
  1297. property = "leveldb." + property
  1298. }
  1299. return ldb.LDB().GetProperty(property)
  1300. }
  1301. func (api *PrivateDebugAPI) ChaindbCompact() error {
  1302. ldb, ok := api.b.ChainDb().(interface {
  1303. LDB() *leveldb.DB
  1304. })
  1305. if !ok {
  1306. return fmt.Errorf("chaindbCompact does not work for memory databases")
  1307. }
  1308. for b := byte(0); b < 255; b++ {
  1309. log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
  1310. err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}})
  1311. if err != nil {
  1312. log.Error("Database compaction failed", "err", err)
  1313. return err
  1314. }
  1315. }
  1316. return nil
  1317. }
  1318. // SetHead rewinds the head of the blockchain to a previous block.
  1319. func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
  1320. api.b.SetHead(uint64(number))
  1321. }
  1322. // PublicNetAPI offers network related RPC methods
  1323. type PublicNetAPI struct {
  1324. net *p2p.Server
  1325. networkVersion uint64
  1326. }
  1327. // NewPublicNetAPI creates a new net API instance.
  1328. func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
  1329. return &PublicNetAPI{net, networkVersion}
  1330. }
  1331. // Listening returns an indication if the node is listening for network connections.
  1332. func (s *PublicNetAPI) Listening() bool {
  1333. return true // always listening
  1334. }
  1335. // PeerCount returns the number of connected peers
  1336. func (s *PublicNetAPI) PeerCount() hexutil.Uint {
  1337. return hexutil.Uint(s.net.PeerCount())
  1338. }
  1339. // Version returns the current ethereum protocol version.
  1340. func (s *PublicNetAPI) Version() string {
  1341. return fmt.Sprintf("%d", s.networkVersion)
  1342. }