api.go 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491
  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/davecgh/go-spew/spew"
  26. "github.com/ethereum/go-ethereum/accounts"
  27. "github.com/ethereum/go-ethereum/accounts/keystore"
  28. "github.com/ethereum/go-ethereum/common"
  29. "github.com/ethereum/go-ethereum/common/hexutil"
  30. "github.com/ethereum/go-ethereum/common/math"
  31. "github.com/ethereum/go-ethereum/consensus/ethash"
  32. "github.com/ethereum/go-ethereum/core"
  33. "github.com/ethereum/go-ethereum/core/rawdb"
  34. "github.com/ethereum/go-ethereum/core/types"
  35. "github.com/ethereum/go-ethereum/core/vm"
  36. "github.com/ethereum/go-ethereum/crypto"
  37. "github.com/ethereum/go-ethereum/log"
  38. "github.com/ethereum/go-ethereum/p2p"
  39. "github.com/ethereum/go-ethereum/params"
  40. "github.com/ethereum/go-ethereum/rlp"
  41. "github.com/ethereum/go-ethereum/rpc"
  42. "github.com/syndtr/goleveldb/leveldb"
  43. "github.com/syndtr/goleveldb/leveldb/util"
  44. )
  45. const (
  46. defaultGasPrice = 50 * params.Shannon
  47. )
  48. // PublicEthereumAPI provides an API to access Ethereum related information.
  49. // It offers only methods that operate on public data that is freely available to anyone.
  50. type PublicEthereumAPI struct {
  51. b Backend
  52. }
  53. // NewPublicEthereumAPI creates a new Ethereum protocol API.
  54. func NewPublicEthereumAPI(b Backend) *PublicEthereumAPI {
  55. return &PublicEthereumAPI{b}
  56. }
  57. // GasPrice returns a suggestion for a gas price.
  58. func (s *PublicEthereumAPI) GasPrice(ctx context.Context) (*hexutil.Big, error) {
  59. price, err := s.b.SuggestPrice(ctx)
  60. return (*hexutil.Big)(price), err
  61. }
  62. // ProtocolVersion returns the current Ethereum protocol version this node supports
  63. func (s *PublicEthereumAPI) ProtocolVersion() hexutil.Uint {
  64. return hexutil.Uint(s.b.ProtocolVersion())
  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. addresses := make([]common.Address, 0) // return [] instead of nil if empty
  174. for _, wallet := range s.am.Wallets() {
  175. for _, account := range wallet.Accounts() {
  176. addresses = append(addresses, account.Address)
  177. }
  178. }
  179. return addresses
  180. }
  181. // PrivateAccountAPI provides an API to access accounts managed by this node.
  182. // It offers methods to create, (un)lock en list accounts. Some methods accept
  183. // passwords and are therefore considered private by default.
  184. type PrivateAccountAPI struct {
  185. am *accounts.Manager
  186. nonceLock *AddrLocker
  187. b Backend
  188. }
  189. // NewPrivateAccountAPI create a new PrivateAccountAPI.
  190. func NewPrivateAccountAPI(b Backend, nonceLock *AddrLocker) *PrivateAccountAPI {
  191. return &PrivateAccountAPI{
  192. am: b.AccountManager(),
  193. nonceLock: nonceLock,
  194. b: b,
  195. }
  196. }
  197. // ListAccounts will return a list of addresses for accounts this node manages.
  198. func (s *PrivateAccountAPI) ListAccounts() []common.Address {
  199. addresses := make([]common.Address, 0) // return [] instead of nil if empty
  200. for _, wallet := range s.am.Wallets() {
  201. for _, account := range wallet.Accounts() {
  202. addresses = append(addresses, account.Address)
  203. }
  204. }
  205. return addresses
  206. }
  207. // rawWallet is a JSON representation of an accounts.Wallet interface, with its
  208. // data contents extracted into plain fields.
  209. type rawWallet struct {
  210. URL string `json:"url"`
  211. Status string `json:"status"`
  212. Failure string `json:"failure,omitempty"`
  213. Accounts []accounts.Account `json:"accounts,omitempty"`
  214. }
  215. // ListWallets will return a list of wallets this node manages.
  216. func (s *PrivateAccountAPI) ListWallets() []rawWallet {
  217. wallets := make([]rawWallet, 0) // return [] instead of nil if empty
  218. for _, wallet := range s.am.Wallets() {
  219. status, failure := wallet.Status()
  220. raw := rawWallet{
  221. URL: wallet.URL().String(),
  222. Status: status,
  223. Accounts: wallet.Accounts(),
  224. }
  225. if failure != nil {
  226. raw.Failure = failure.Error()
  227. }
  228. wallets = append(wallets, raw)
  229. }
  230. return wallets
  231. }
  232. // OpenWallet initiates a hardware wallet opening procedure, establishing a USB
  233. // connection and attempting to authenticate via the provided passphrase. Note,
  234. // the method may return an extra challenge requiring a second open (e.g. the
  235. // Trezor PIN matrix challenge).
  236. func (s *PrivateAccountAPI) OpenWallet(url string, passphrase *string) error {
  237. wallet, err := s.am.Wallet(url)
  238. if err != nil {
  239. return err
  240. }
  241. pass := ""
  242. if passphrase != nil {
  243. pass = *passphrase
  244. }
  245. return wallet.Open(pass)
  246. }
  247. // DeriveAccount requests a HD wallet to derive a new account, optionally pinning
  248. // it for later reuse.
  249. func (s *PrivateAccountAPI) DeriveAccount(url string, path string, pin *bool) (accounts.Account, error) {
  250. wallet, err := s.am.Wallet(url)
  251. if err != nil {
  252. return accounts.Account{}, err
  253. }
  254. derivPath, err := accounts.ParseDerivationPath(path)
  255. if err != nil {
  256. return accounts.Account{}, err
  257. }
  258. if pin == nil {
  259. pin = new(bool)
  260. }
  261. return wallet.Derive(derivPath, *pin)
  262. }
  263. // NewAccount will create a new account and returns the address for the new account.
  264. func (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) {
  265. acc, err := fetchKeystore(s.am).NewAccount(password)
  266. if err == nil {
  267. return acc.Address, nil
  268. }
  269. return common.Address{}, err
  270. }
  271. // fetchKeystore retrives the encrypted keystore from the account manager.
  272. func fetchKeystore(am *accounts.Manager) *keystore.KeyStore {
  273. return am.Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
  274. }
  275. // ImportRawKey stores the given hex encoded ECDSA key into the key directory,
  276. // encrypting it with the passphrase.
  277. func (s *PrivateAccountAPI) ImportRawKey(privkey string, password string) (common.Address, error) {
  278. key, err := crypto.HexToECDSA(privkey)
  279. if err != nil {
  280. return common.Address{}, err
  281. }
  282. acc, err := fetchKeystore(s.am).ImportECDSA(key, password)
  283. return acc.Address, err
  284. }
  285. // UnlockAccount will unlock the account associated with the given address with
  286. // the given password for duration seconds. If duration is nil it will use a
  287. // default of 300 seconds. It returns an indication if the account was unlocked.
  288. func (s *PrivateAccountAPI) UnlockAccount(addr common.Address, password string, duration *uint64) (bool, error) {
  289. const max = uint64(time.Duration(math.MaxInt64) / time.Second)
  290. var d time.Duration
  291. if duration == nil {
  292. d = 300 * time.Second
  293. } else if *duration > max {
  294. return false, errors.New("unlock duration too large")
  295. } else {
  296. d = time.Duration(*duration) * time.Second
  297. }
  298. err := fetchKeystore(s.am).TimedUnlock(accounts.Account{Address: addr}, password, d)
  299. return err == nil, err
  300. }
  301. // LockAccount will lock the account associated with the given address when it's unlocked.
  302. func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool {
  303. return fetchKeystore(s.am).Lock(addr) == nil
  304. }
  305. // signTransactions sets defaults and signs the given transaction
  306. // NOTE: the caller needs to ensure that the nonceLock is held, if applicable,
  307. // and release it after the transaction has been submitted to the tx pool
  308. func (s *PrivateAccountAPI) signTransaction(ctx context.Context, args SendTxArgs, passwd string) (*types.Transaction, error) {
  309. // Look up the wallet containing the requested signer
  310. account := accounts.Account{Address: args.From}
  311. wallet, err := s.am.Find(account)
  312. if err != nil {
  313. return nil, err
  314. }
  315. // Set some sanity defaults and terminate on failure
  316. if err := args.setDefaults(ctx, s.b); err != nil {
  317. return nil, err
  318. }
  319. // Assemble the transaction and sign with the wallet
  320. tx := args.toTransaction()
  321. var chainID *big.Int
  322. if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
  323. chainID = config.ChainID
  324. }
  325. return wallet.SignTxWithPassphrase(account, passwd, tx, chainID)
  326. }
  327. // SendTransaction will create a transaction from the given arguments and
  328. // tries to sign it with the key associated with args.To. If the given passwd isn't
  329. // able to decrypt the key it fails.
  330. func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
  331. if args.Nonce == nil {
  332. // Hold the addresse's mutex around signing to prevent concurrent assignment of
  333. // the same nonce to multiple accounts.
  334. s.nonceLock.LockAddr(args.From)
  335. defer s.nonceLock.UnlockAddr(args.From)
  336. }
  337. signed, err := s.signTransaction(ctx, args, passwd)
  338. if err != nil {
  339. return common.Hash{}, err
  340. }
  341. return submitTransaction(ctx, s.b, signed)
  342. }
  343. // SignTransaction will create a transaction from the given arguments and
  344. // tries to sign it with the key associated with args.To. If the given passwd isn't
  345. // able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast
  346. // to other nodes
  347. func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args SendTxArgs, passwd string) (*SignTransactionResult, error) {
  348. // No need to obtain the noncelock mutex, since we won't be sending this
  349. // tx into the transaction pool, but right back to the user
  350. if args.Gas == nil {
  351. return nil, fmt.Errorf("gas not specified")
  352. }
  353. if args.GasPrice == nil {
  354. return nil, fmt.Errorf("gasPrice not specified")
  355. }
  356. if args.Nonce == nil {
  357. return nil, fmt.Errorf("nonce not specified")
  358. }
  359. signed, err := s.signTransaction(ctx, args, passwd)
  360. if err != nil {
  361. return nil, err
  362. }
  363. data, err := rlp.EncodeToBytes(signed)
  364. if err != nil {
  365. return nil, err
  366. }
  367. return &SignTransactionResult{data, signed}, nil
  368. }
  369. // signHash is a helper function that calculates a hash for the given message that can be
  370. // safely used to calculate a signature from.
  371. //
  372. // The hash is calulcated as
  373. // keccak256("\x19Ethereum Signed Message:\n"${message length}${message}).
  374. //
  375. // This gives context to the signed message and prevents signing of transactions.
  376. func signHash(data []byte) []byte {
  377. msg := fmt.Sprintf("\x19Ethereum Signed Message:\n%d%s", len(data), data)
  378. return crypto.Keccak256([]byte(msg))
  379. }
  380. // Sign calculates an Ethereum ECDSA signature for:
  381. // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message))
  382. //
  383. // Note, the produced signature conforms to the secp256k1 curve R, S and V values,
  384. // where the V value will be 27 or 28 for legacy reasons.
  385. //
  386. // The key used to calculate the signature is decrypted with the given password.
  387. //
  388. // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign
  389. func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {
  390. // Look up the wallet containing the requested signer
  391. account := accounts.Account{Address: addr}
  392. wallet, err := s.b.AccountManager().Find(account)
  393. if err != nil {
  394. return nil, err
  395. }
  396. // Assemble sign the data with the wallet
  397. signature, err := wallet.SignHashWithPassphrase(account, passwd, signHash(data))
  398. if err != nil {
  399. return nil, err
  400. }
  401. signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
  402. return signature, nil
  403. }
  404. // EcRecover returns the address for the account that was used to create the signature.
  405. // Note, this function is compatible with eth_sign and personal_sign. As such it recovers
  406. // the address of:
  407. // hash = keccak256("\x19Ethereum Signed Message:\n"${message length}${message})
  408. // addr = ecrecover(hash, signature)
  409. //
  410. // Note, the signature must conform to the secp256k1 curve R, S and V values, where
  411. // the V value must be be 27 or 28 for legacy reasons.
  412. //
  413. // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover
  414. func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {
  415. if len(sig) != 65 {
  416. return common.Address{}, fmt.Errorf("signature must be 65 bytes long")
  417. }
  418. if sig[64] != 27 && sig[64] != 28 {
  419. return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)")
  420. }
  421. sig[64] -= 27 // Transform yellow paper V from 27/28 to 0/1
  422. rpk, err := crypto.SigToPub(signHash(data), sig)
  423. if err != nil {
  424. return common.Address{}, err
  425. }
  426. return crypto.PubkeyToAddress(*rpk), nil
  427. }
  428. // SignAndSendTransaction was renamed to SendTransaction. This method is deprecated
  429. // and will be removed in the future. It primary goal is to give clients time to update.
  430. func (s *PrivateAccountAPI) SignAndSendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
  431. return s.SendTransaction(ctx, args, passwd)
  432. }
  433. // PublicBlockChainAPI provides an API to access the Ethereum blockchain.
  434. // It offers only methods that operate on public data that is freely available to anyone.
  435. type PublicBlockChainAPI struct {
  436. b Backend
  437. }
  438. // NewPublicBlockChainAPI creates a new Ethereum blockchain API.
  439. func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI {
  440. return &PublicBlockChainAPI{b}
  441. }
  442. // BlockNumber returns the block number of the chain head.
  443. func (s *PublicBlockChainAPI) BlockNumber() hexutil.Uint64 {
  444. header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available
  445. return hexutil.Uint64(header.Number.Uint64())
  446. }
  447. // GetBalance returns the amount of wei for the given address in the state of the
  448. // given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta
  449. // block numbers are also allowed.
  450. func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Big, error) {
  451. state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
  452. if state == nil || err != nil {
  453. return nil, err
  454. }
  455. return (*hexutil.Big)(state.GetBalance(address)), 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, timeout time.Duration) ([]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 = math.MaxUint64 / 2
  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 timeout > 0 {
  586. ctx, cancel = context.WithTimeout(ctx, timeout)
  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 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{}, 5*time.Second)
  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{}, 0)
  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. // RPCMarshalBlock 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 RPCMarshalBlock(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. "extraData": hexutil.Bytes(head.Extra),
  740. "size": hexutil.Uint64(b.Size()),
  741. "gasLimit": hexutil.Uint64(head.GasLimit),
  742. "gasUsed": hexutil.Uint64(head.GasUsed),
  743. "timestamp": (*hexutil.Big)(head.Time),
  744. "transactionsRoot": head.TxHash,
  745. "receiptsRoot": head.ReceiptHash,
  746. }
  747. if inclTx {
  748. formatTx := func(tx *types.Transaction) (interface{}, error) {
  749. return tx.Hash(), nil
  750. }
  751. if fullTx {
  752. formatTx = func(tx *types.Transaction) (interface{}, error) {
  753. return newRPCTransactionFromBlockHash(b, tx.Hash()), nil
  754. }
  755. }
  756. txs := b.Transactions()
  757. transactions := make([]interface{}, len(txs))
  758. var err error
  759. for i, tx := range txs {
  760. if transactions[i], err = formatTx(tx); err != nil {
  761. return nil, err
  762. }
  763. }
  764. fields["transactions"] = transactions
  765. }
  766. uncles := b.Uncles()
  767. uncleHashes := make([]common.Hash, len(uncles))
  768. for i, uncle := range uncles {
  769. uncleHashes[i] = uncle.Hash()
  770. }
  771. fields["uncles"] = uncleHashes
  772. return fields, nil
  773. }
  774. // rpcOutputBlock uses the generalized output filler, then adds the total difficulty field, which requires
  775. // a `PublicBlockchainAPI`.
  776. func (s *PublicBlockChainAPI) rpcOutputBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
  777. fields, err := RPCMarshalBlock(b, inclTx, fullTx)
  778. if err != nil {
  779. return nil, err
  780. }
  781. fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(b.Hash()))
  782. return fields, err
  783. }
  784. // RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction
  785. type RPCTransaction struct {
  786. BlockHash common.Hash `json:"blockHash"`
  787. BlockNumber *hexutil.Big `json:"blockNumber"`
  788. From common.Address `json:"from"`
  789. Gas hexutil.Uint64 `json:"gas"`
  790. GasPrice *hexutil.Big `json:"gasPrice"`
  791. Hash common.Hash `json:"hash"`
  792. Input hexutil.Bytes `json:"input"`
  793. Nonce hexutil.Uint64 `json:"nonce"`
  794. To *common.Address `json:"to"`
  795. TransactionIndex hexutil.Uint `json:"transactionIndex"`
  796. Value *hexutil.Big `json:"value"`
  797. V *hexutil.Big `json:"v"`
  798. R *hexutil.Big `json:"r"`
  799. S *hexutil.Big `json:"s"`
  800. }
  801. // newRPCTransaction returns a transaction that will serialize to the RPC
  802. // representation, with the given location metadata set (if available).
  803. func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64) *RPCTransaction {
  804. var signer types.Signer = types.FrontierSigner{}
  805. if tx.Protected() {
  806. signer = types.NewEIP155Signer(tx.ChainId())
  807. }
  808. from, _ := types.Sender(signer, tx)
  809. v, r, s := tx.RawSignatureValues()
  810. result := &RPCTransaction{
  811. From: from,
  812. Gas: hexutil.Uint64(tx.Gas()),
  813. GasPrice: (*hexutil.Big)(tx.GasPrice()),
  814. Hash: tx.Hash(),
  815. Input: hexutil.Bytes(tx.Data()),
  816. Nonce: hexutil.Uint64(tx.Nonce()),
  817. To: tx.To(),
  818. Value: (*hexutil.Big)(tx.Value()),
  819. V: (*hexutil.Big)(v),
  820. R: (*hexutil.Big)(r),
  821. S: (*hexutil.Big)(s),
  822. }
  823. if blockHash != (common.Hash{}) {
  824. result.BlockHash = blockHash
  825. result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber))
  826. result.TransactionIndex = hexutil.Uint(index)
  827. }
  828. return result
  829. }
  830. // newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation
  831. func newRPCPendingTransaction(tx *types.Transaction) *RPCTransaction {
  832. return newRPCTransaction(tx, common.Hash{}, 0, 0)
  833. }
  834. // newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation.
  835. func newRPCTransactionFromBlockIndex(b *types.Block, index uint64) *RPCTransaction {
  836. txs := b.Transactions()
  837. if index >= uint64(len(txs)) {
  838. return nil
  839. }
  840. return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index)
  841. }
  842. // newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index.
  843. func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes {
  844. txs := b.Transactions()
  845. if index >= uint64(len(txs)) {
  846. return nil
  847. }
  848. blob, _ := rlp.EncodeToBytes(txs[index])
  849. return blob
  850. }
  851. // newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
  852. func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction {
  853. for idx, tx := range b.Transactions() {
  854. if tx.Hash() == hash {
  855. return newRPCTransactionFromBlockIndex(b, uint64(idx))
  856. }
  857. }
  858. return nil
  859. }
  860. // PublicTransactionPoolAPI exposes methods for the RPC interface
  861. type PublicTransactionPoolAPI struct {
  862. b Backend
  863. nonceLock *AddrLocker
  864. }
  865. // NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
  866. func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI {
  867. return &PublicTransactionPoolAPI{b, nonceLock}
  868. }
  869. // GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
  870. func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
  871. if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
  872. n := hexutil.Uint(len(block.Transactions()))
  873. return &n
  874. }
  875. return nil
  876. }
  877. // GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
  878. func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
  879. if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
  880. n := hexutil.Uint(len(block.Transactions()))
  881. return &n
  882. }
  883. return nil
  884. }
  885. // GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
  886. func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
  887. if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
  888. return newRPCTransactionFromBlockIndex(block, uint64(index))
  889. }
  890. return nil
  891. }
  892. // GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
  893. func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
  894. if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
  895. return newRPCTransactionFromBlockIndex(block, uint64(index))
  896. }
  897. return nil
  898. }
  899. // GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
  900. func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
  901. if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
  902. return newRPCRawTransactionFromBlockIndex(block, uint64(index))
  903. }
  904. return nil
  905. }
  906. // GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
  907. func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
  908. if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
  909. return newRPCRawTransactionFromBlockIndex(block, uint64(index))
  910. }
  911. return nil
  912. }
  913. // GetTransactionCount returns the number of transactions the given address has sent for the given block number
  914. func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) {
  915. state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
  916. if state == nil || err != nil {
  917. return nil, err
  918. }
  919. nonce := state.GetNonce(address)
  920. return (*hexutil.Uint64)(&nonce), state.Error()
  921. }
  922. // GetTransactionByHash returns the transaction for the given hash
  923. func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) *RPCTransaction {
  924. // Try to return an already finalized transaction
  925. if tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash); tx != nil {
  926. return newRPCTransaction(tx, blockHash, blockNumber, index)
  927. }
  928. // No finalized transaction, try to retrieve it from the pool
  929. if tx := s.b.GetPoolTransaction(hash); tx != nil {
  930. return newRPCPendingTransaction(tx)
  931. }
  932. // Transaction unknown, return as such
  933. return nil
  934. }
  935. // GetRawTransactionByHash returns the bytes of the transaction for the given hash.
  936. func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
  937. var tx *types.Transaction
  938. // Retrieve a finalized transaction, or a pooled otherwise
  939. if tx, _, _, _ = rawdb.ReadTransaction(s.b.ChainDb(), hash); tx == nil {
  940. if tx = s.b.GetPoolTransaction(hash); tx == nil {
  941. // Transaction not found anywhere, abort
  942. return nil, nil
  943. }
  944. }
  945. // Serialize to RLP and return
  946. return rlp.EncodeToBytes(tx)
  947. }
  948. // GetTransactionReceipt returns the transaction receipt for the given transaction hash.
  949. func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {
  950. tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash)
  951. if tx == nil {
  952. return nil, nil
  953. }
  954. receipts, err := s.b.GetReceipts(ctx, blockHash)
  955. if err != nil {
  956. return nil, err
  957. }
  958. if len(receipts) <= int(index) {
  959. return nil, nil
  960. }
  961. receipt := receipts[index]
  962. var signer types.Signer = types.FrontierSigner{}
  963. if tx.Protected() {
  964. signer = types.NewEIP155Signer(tx.ChainId())
  965. }
  966. from, _ := types.Sender(signer, tx)
  967. fields := map[string]interface{}{
  968. "blockHash": blockHash,
  969. "blockNumber": hexutil.Uint64(blockNumber),
  970. "transactionHash": hash,
  971. "transactionIndex": hexutil.Uint64(index),
  972. "from": from,
  973. "to": tx.To(),
  974. "gasUsed": hexutil.Uint64(receipt.GasUsed),
  975. "cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed),
  976. "contractAddress": nil,
  977. "logs": receipt.Logs,
  978. "logsBloom": receipt.Bloom,
  979. }
  980. // Assign receipt status or post state.
  981. if len(receipt.PostState) > 0 {
  982. fields["root"] = hexutil.Bytes(receipt.PostState)
  983. } else {
  984. fields["status"] = hexutil.Uint(receipt.Status)
  985. }
  986. if receipt.Logs == nil {
  987. fields["logs"] = [][]*types.Log{}
  988. }
  989. // If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
  990. if receipt.ContractAddress != (common.Address{}) {
  991. fields["contractAddress"] = receipt.ContractAddress
  992. }
  993. return fields, nil
  994. }
  995. // sign is a helper function that signs a transaction with the private key of the given address.
  996. func (s *PublicTransactionPoolAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) {
  997. // Look up the wallet containing the requested signer
  998. account := accounts.Account{Address: addr}
  999. wallet, err := s.b.AccountManager().Find(account)
  1000. if err != nil {
  1001. return nil, err
  1002. }
  1003. // Request the wallet to sign the transaction
  1004. var chainID *big.Int
  1005. if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
  1006. chainID = config.ChainID
  1007. }
  1008. return wallet.SignTx(account, tx, chainID)
  1009. }
  1010. // SendTxArgs represents the arguments to sumbit a new transaction into the transaction pool.
  1011. type SendTxArgs struct {
  1012. From common.Address `json:"from"`
  1013. To *common.Address `json:"to"`
  1014. Gas *hexutil.Uint64 `json:"gas"`
  1015. GasPrice *hexutil.Big `json:"gasPrice"`
  1016. Value *hexutil.Big `json:"value"`
  1017. Nonce *hexutil.Uint64 `json:"nonce"`
  1018. // We accept "data" and "input" for backwards-compatibility reasons. "input" is the
  1019. // newer name and should be preferred by clients.
  1020. Data *hexutil.Bytes `json:"data"`
  1021. Input *hexutil.Bytes `json:"input"`
  1022. }
  1023. // setDefaults is a helper function that fills in default values for unspecified tx fields.
  1024. func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
  1025. if args.Gas == nil {
  1026. args.Gas = new(hexutil.Uint64)
  1027. *(*uint64)(args.Gas) = 90000
  1028. }
  1029. if args.GasPrice == nil {
  1030. price, err := b.SuggestPrice(ctx)
  1031. if err != nil {
  1032. return err
  1033. }
  1034. args.GasPrice = (*hexutil.Big)(price)
  1035. }
  1036. if args.Value == nil {
  1037. args.Value = new(hexutil.Big)
  1038. }
  1039. if args.Nonce == nil {
  1040. nonce, err := b.GetPoolNonce(ctx, args.From)
  1041. if err != nil {
  1042. return err
  1043. }
  1044. args.Nonce = (*hexutil.Uint64)(&nonce)
  1045. }
  1046. if args.Data != nil && args.Input != nil && !bytes.Equal(*args.Data, *args.Input) {
  1047. return errors.New(`Both "data" and "input" are set and not equal. Please use "input" to pass transaction call data.`)
  1048. }
  1049. if args.To == nil {
  1050. // Contract creation
  1051. var input []byte
  1052. if args.Data != nil {
  1053. input = *args.Data
  1054. } else if args.Input != nil {
  1055. input = *args.Input
  1056. }
  1057. if len(input) == 0 {
  1058. return errors.New(`contract creation without any data provided`)
  1059. }
  1060. }
  1061. return nil
  1062. }
  1063. func (args *SendTxArgs) toTransaction() *types.Transaction {
  1064. var input []byte
  1065. if args.Data != nil {
  1066. input = *args.Data
  1067. } else if args.Input != nil {
  1068. input = *args.Input
  1069. }
  1070. if args.To == nil {
  1071. return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
  1072. }
  1073. return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
  1074. }
  1075. // submitTransaction is a helper function that submits tx to txPool and logs a message.
  1076. func submitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) {
  1077. if err := b.SendTx(ctx, tx); err != nil {
  1078. return common.Hash{}, err
  1079. }
  1080. if tx.To() == nil {
  1081. signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
  1082. from, err := types.Sender(signer, tx)
  1083. if err != nil {
  1084. return common.Hash{}, err
  1085. }
  1086. addr := crypto.CreateAddress(from, tx.Nonce())
  1087. log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
  1088. } else {
  1089. log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
  1090. }
  1091. return tx.Hash(), nil
  1092. }
  1093. // SendTransaction creates a transaction for the given argument, sign it and submit it to the
  1094. // transaction pool.
  1095. func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args SendTxArgs) (common.Hash, error) {
  1096. // Look up the wallet containing the requested signer
  1097. account := accounts.Account{Address: args.From}
  1098. wallet, err := s.b.AccountManager().Find(account)
  1099. if err != nil {
  1100. return common.Hash{}, err
  1101. }
  1102. if args.Nonce == nil {
  1103. // Hold the addresse's mutex around signing to prevent concurrent assignment of
  1104. // the same nonce to multiple accounts.
  1105. s.nonceLock.LockAddr(args.From)
  1106. defer s.nonceLock.UnlockAddr(args.From)
  1107. }
  1108. // Set some sanity defaults and terminate on failure
  1109. if err := args.setDefaults(ctx, s.b); err != nil {
  1110. return common.Hash{}, err
  1111. }
  1112. // Assemble the transaction and sign with the wallet
  1113. tx := args.toTransaction()
  1114. var chainID *big.Int
  1115. if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
  1116. chainID = config.ChainID
  1117. }
  1118. signed, err := wallet.SignTx(account, tx, chainID)
  1119. if err != nil {
  1120. return common.Hash{}, err
  1121. }
  1122. return submitTransaction(ctx, s.b, signed)
  1123. }
  1124. // SendRawTransaction will add the signed transaction to the transaction pool.
  1125. // The sender is responsible for signing the transaction and using the correct nonce.
  1126. func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) {
  1127. tx := new(types.Transaction)
  1128. if err := rlp.DecodeBytes(encodedTx, tx); err != nil {
  1129. return common.Hash{}, err
  1130. }
  1131. return submitTransaction(ctx, s.b, tx)
  1132. }
  1133. // Sign calculates an ECDSA signature for:
  1134. // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
  1135. //
  1136. // Note, the produced signature conforms to the secp256k1 curve R, S and V values,
  1137. // where the V value will be 27 or 28 for legacy reasons.
  1138. //
  1139. // The account associated with addr must be unlocked.
  1140. //
  1141. // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
  1142. func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
  1143. // Look up the wallet containing the requested signer
  1144. account := accounts.Account{Address: addr}
  1145. wallet, err := s.b.AccountManager().Find(account)
  1146. if err != nil {
  1147. return nil, err
  1148. }
  1149. // Sign the requested hash with the wallet
  1150. signature, err := wallet.SignHash(account, signHash(data))
  1151. if err == nil {
  1152. signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
  1153. }
  1154. return signature, err
  1155. }
  1156. // SignTransactionResult represents a RLP encoded signed transaction.
  1157. type SignTransactionResult struct {
  1158. Raw hexutil.Bytes `json:"raw"`
  1159. Tx *types.Transaction `json:"tx"`
  1160. }
  1161. // SignTransaction will sign the given transaction with the from account.
  1162. // The node needs to have the private key of the account corresponding with
  1163. // the given from address and it needs to be unlocked.
  1164. func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
  1165. if args.Gas == nil {
  1166. return nil, fmt.Errorf("gas not specified")
  1167. }
  1168. if args.GasPrice == nil {
  1169. return nil, fmt.Errorf("gasPrice not specified")
  1170. }
  1171. if args.Nonce == nil {
  1172. return nil, fmt.Errorf("nonce not specified")
  1173. }
  1174. if err := args.setDefaults(ctx, s.b); err != nil {
  1175. return nil, err
  1176. }
  1177. tx, err := s.sign(args.From, args.toTransaction())
  1178. if err != nil {
  1179. return nil, err
  1180. }
  1181. data, err := rlp.EncodeToBytes(tx)
  1182. if err != nil {
  1183. return nil, err
  1184. }
  1185. return &SignTransactionResult{data, tx}, nil
  1186. }
  1187. // PendingTransactions returns the transactions that are in the transaction pool
  1188. // and have a from address that is one of the accounts this node manages.
  1189. func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
  1190. pending, err := s.b.GetPoolTransactions()
  1191. if err != nil {
  1192. return nil, err
  1193. }
  1194. accounts := make(map[common.Address]struct{})
  1195. for _, wallet := range s.b.AccountManager().Wallets() {
  1196. for _, account := range wallet.Accounts() {
  1197. accounts[account.Address] = struct{}{}
  1198. }
  1199. }
  1200. transactions := make([]*RPCTransaction, 0, len(pending))
  1201. for _, tx := range pending {
  1202. var signer types.Signer = types.HomesteadSigner{}
  1203. if tx.Protected() {
  1204. signer = types.NewEIP155Signer(tx.ChainId())
  1205. }
  1206. from, _ := types.Sender(signer, tx)
  1207. if _, exists := accounts[from]; exists {
  1208. transactions = append(transactions, newRPCPendingTransaction(tx))
  1209. }
  1210. }
  1211. return transactions, nil
  1212. }
  1213. // Resend accepts an existing transaction and a new gas price and limit. It will remove
  1214. // the given transaction from the pool and reinsert it with the new gas price and limit.
  1215. func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {
  1216. if sendArgs.Nonce == nil {
  1217. return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec")
  1218. }
  1219. if err := sendArgs.setDefaults(ctx, s.b); err != nil {
  1220. return common.Hash{}, err
  1221. }
  1222. matchTx := sendArgs.toTransaction()
  1223. pending, err := s.b.GetPoolTransactions()
  1224. if err != nil {
  1225. return common.Hash{}, err
  1226. }
  1227. for _, p := range pending {
  1228. var signer types.Signer = types.HomesteadSigner{}
  1229. if p.Protected() {
  1230. signer = types.NewEIP155Signer(p.ChainId())
  1231. }
  1232. wantSigHash := signer.Hash(matchTx)
  1233. if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash {
  1234. // Match. Re-sign and send the transaction.
  1235. if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 {
  1236. sendArgs.GasPrice = gasPrice
  1237. }
  1238. if gasLimit != nil && *gasLimit != 0 {
  1239. sendArgs.Gas = gasLimit
  1240. }
  1241. signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())
  1242. if err != nil {
  1243. return common.Hash{}, err
  1244. }
  1245. if err = s.b.SendTx(ctx, signedTx); err != nil {
  1246. return common.Hash{}, err
  1247. }
  1248. return signedTx.Hash(), nil
  1249. }
  1250. }
  1251. return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash())
  1252. }
  1253. // PublicDebugAPI is the collection of Ethereum APIs exposed over the public
  1254. // debugging endpoint.
  1255. type PublicDebugAPI struct {
  1256. b Backend
  1257. }
  1258. // NewPublicDebugAPI creates a new API definition for the public debug methods
  1259. // of the Ethereum service.
  1260. func NewPublicDebugAPI(b Backend) *PublicDebugAPI {
  1261. return &PublicDebugAPI{b: b}
  1262. }
  1263. // GetBlockRlp retrieves the RLP encoded for of a single block.
  1264. func (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) {
  1265. block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1266. if block == nil {
  1267. return "", fmt.Errorf("block #%d not found", number)
  1268. }
  1269. encoded, err := rlp.EncodeToBytes(block)
  1270. if err != nil {
  1271. return "", err
  1272. }
  1273. return fmt.Sprintf("%x", encoded), nil
  1274. }
  1275. // PrintBlock retrieves a block and returns its pretty printed form.
  1276. func (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) {
  1277. block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1278. if block == nil {
  1279. return "", fmt.Errorf("block #%d not found", number)
  1280. }
  1281. return spew.Sdump(block), nil
  1282. }
  1283. // SeedHash retrieves the seed hash of a block.
  1284. func (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) {
  1285. block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1286. if block == nil {
  1287. return "", fmt.Errorf("block #%d not found", number)
  1288. }
  1289. return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil
  1290. }
  1291. // PrivateDebugAPI is the collection of Ethereum APIs exposed over the private
  1292. // debugging endpoint.
  1293. type PrivateDebugAPI struct {
  1294. b Backend
  1295. }
  1296. // NewPrivateDebugAPI creates a new API definition for the private debug methods
  1297. // of the Ethereum service.
  1298. func NewPrivateDebugAPI(b Backend) *PrivateDebugAPI {
  1299. return &PrivateDebugAPI{b: b}
  1300. }
  1301. // ChaindbProperty returns leveldb properties of the chain database.
  1302. func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) {
  1303. ldb, ok := api.b.ChainDb().(interface {
  1304. LDB() *leveldb.DB
  1305. })
  1306. if !ok {
  1307. return "", fmt.Errorf("chaindbProperty does not work for memory databases")
  1308. }
  1309. if property == "" {
  1310. property = "leveldb.stats"
  1311. } else if !strings.HasPrefix(property, "leveldb.") {
  1312. property = "leveldb." + property
  1313. }
  1314. return ldb.LDB().GetProperty(property)
  1315. }
  1316. func (api *PrivateDebugAPI) ChaindbCompact() error {
  1317. ldb, ok := api.b.ChainDb().(interface {
  1318. LDB() *leveldb.DB
  1319. })
  1320. if !ok {
  1321. return fmt.Errorf("chaindbCompact does not work for memory databases")
  1322. }
  1323. for b := byte(0); b < 255; b++ {
  1324. log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
  1325. err := ldb.LDB().CompactRange(util.Range{Start: []byte{b}, Limit: []byte{b + 1}})
  1326. if err != nil {
  1327. log.Error("Database compaction failed", "err", err)
  1328. return err
  1329. }
  1330. }
  1331. return nil
  1332. }
  1333. // SetHead rewinds the head of the blockchain to a previous block.
  1334. func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
  1335. api.b.SetHead(uint64(number))
  1336. }
  1337. // PublicNetAPI offers network related RPC methods
  1338. type PublicNetAPI struct {
  1339. net *p2p.Server
  1340. networkVersion uint64
  1341. }
  1342. // NewPublicNetAPI creates a new net API instance.
  1343. func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
  1344. return &PublicNetAPI{net, networkVersion}
  1345. }
  1346. // Listening returns an indication if the node is listening for network connections.
  1347. func (s *PublicNetAPI) Listening() bool {
  1348. return true // always listening
  1349. }
  1350. // PeerCount returns the number of connected peers
  1351. func (s *PublicNetAPI) PeerCount() hexutil.Uint {
  1352. return hexutil.Uint(s.net.PeerCount())
  1353. }
  1354. // Version returns the current ethereum protocol version.
  1355. func (s *PublicNetAPI) Version() string {
  1356. return fmt.Sprintf("%d", s.networkVersion)
  1357. }