api.go 57 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612
  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/clique"
  32. "github.com/ethereum/go-ethereum/consensus/ethash"
  33. "github.com/ethereum/go-ethereum/core"
  34. "github.com/ethereum/go-ethereum/core/rawdb"
  35. "github.com/ethereum/go-ethereum/core/types"
  36. "github.com/ethereum/go-ethereum/core/vm"
  37. "github.com/ethereum/go-ethereum/crypto"
  38. "github.com/ethereum/go-ethereum/log"
  39. "github.com/ethereum/go-ethereum/p2p"
  40. "github.com/ethereum/go-ethereum/params"
  41. "github.com/ethereum/go-ethereum/rlp"
  42. "github.com/ethereum/go-ethereum/rpc"
  43. "github.com/syndtr/goleveldb/leveldb"
  44. )
  45. const (
  46. defaultGasPrice = params.GWei
  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(ctx context.Context, addr common.Address, password string, duration *uint64) (bool, error) {
  289. // When the API is exposed by external RPC(http, ws etc), unless the user
  290. // explicitly specifies to allow the insecure account unlocking, otherwise
  291. // it is disabled.
  292. if s.b.ExtRPCEnabled() && !s.b.AccountManager().Config().InsecureUnlockAllowed {
  293. return false, errors.New("account unlock with HTTP access is forbidden")
  294. }
  295. const max = uint64(time.Duration(math.MaxInt64) / time.Second)
  296. var d time.Duration
  297. if duration == nil {
  298. d = 300 * time.Second
  299. } else if *duration > max {
  300. return false, errors.New("unlock duration too large")
  301. } else {
  302. d = time.Duration(*duration) * time.Second
  303. }
  304. err := fetchKeystore(s.am).TimedUnlock(accounts.Account{Address: addr}, password, d)
  305. if err != nil {
  306. log.Warn("Failed account unlock attempt", "address", addr, "err", err)
  307. }
  308. return err == nil, err
  309. }
  310. // LockAccount will lock the account associated with the given address when it's unlocked.
  311. func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool {
  312. return fetchKeystore(s.am).Lock(addr) == nil
  313. }
  314. // signTransaction sets defaults and signs the given transaction
  315. // NOTE: the caller needs to ensure that the nonceLock is held, if applicable,
  316. // and release it after the transaction has been submitted to the tx pool
  317. func (s *PrivateAccountAPI) signTransaction(ctx context.Context, args *SendTxArgs, passwd string) (*types.Transaction, error) {
  318. // Look up the wallet containing the requested signer
  319. account := accounts.Account{Address: args.From}
  320. wallet, err := s.am.Find(account)
  321. if err != nil {
  322. return nil, err
  323. }
  324. // Set some sanity defaults and terminate on failure
  325. if err := args.setDefaults(ctx, s.b); err != nil {
  326. return nil, err
  327. }
  328. // Assemble the transaction and sign with the wallet
  329. tx := args.toTransaction()
  330. return wallet.SignTxWithPassphrase(account, passwd, tx, s.b.ChainConfig().ChainID)
  331. }
  332. // SendTransaction will create a transaction from the given arguments and
  333. // tries to sign it with the key associated with args.To. If the given passwd isn't
  334. // able to decrypt the key it fails.
  335. func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
  336. if args.Nonce == nil {
  337. // Hold the addresse's mutex around signing to prevent concurrent assignment of
  338. // the same nonce to multiple accounts.
  339. s.nonceLock.LockAddr(args.From)
  340. defer s.nonceLock.UnlockAddr(args.From)
  341. }
  342. signed, err := s.signTransaction(ctx, &args, passwd)
  343. if err != nil {
  344. log.Warn("Failed transaction send attempt", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err)
  345. return common.Hash{}, err
  346. }
  347. return SubmitTransaction(ctx, s.b, signed)
  348. }
  349. // SignTransaction will create a transaction from the given arguments and
  350. // tries to sign it with the key associated with args.To. If the given passwd isn't
  351. // able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast
  352. // to other nodes
  353. func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args SendTxArgs, passwd string) (*SignTransactionResult, error) {
  354. // No need to obtain the noncelock mutex, since we won't be sending this
  355. // tx into the transaction pool, but right back to the user
  356. if args.Gas == nil {
  357. return nil, fmt.Errorf("gas not specified")
  358. }
  359. if args.GasPrice == nil {
  360. return nil, fmt.Errorf("gasPrice not specified")
  361. }
  362. if args.Nonce == nil {
  363. return nil, fmt.Errorf("nonce not specified")
  364. }
  365. signed, err := s.signTransaction(ctx, &args, passwd)
  366. if err != nil {
  367. log.Warn("Failed transaction sign attempt", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err)
  368. return nil, err
  369. }
  370. data, err := rlp.EncodeToBytes(signed)
  371. if err != nil {
  372. return nil, err
  373. }
  374. return &SignTransactionResult{data, signed}, nil
  375. }
  376. // Sign calculates an Ethereum ECDSA signature for:
  377. // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message))
  378. //
  379. // Note, the produced signature conforms to the secp256k1 curve R, S and V values,
  380. // where the V value will be 27 or 28 for legacy reasons.
  381. //
  382. // The key used to calculate the signature is decrypted with the given password.
  383. //
  384. // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign
  385. func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {
  386. // Look up the wallet containing the requested signer
  387. account := accounts.Account{Address: addr}
  388. wallet, err := s.b.AccountManager().Find(account)
  389. if err != nil {
  390. return nil, err
  391. }
  392. // Assemble sign the data with the wallet
  393. signature, err := wallet.SignTextWithPassphrase(account, passwd, data)
  394. if err != nil {
  395. log.Warn("Failed data sign attempt", "address", addr, "err", err)
  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 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.SigToPub(accounts.TextHash(data), sig)
  420. if err != nil {
  421. return common.Address{}, err
  422. }
  423. return crypto.PubkeyToAddress(*rpk), nil
  424. }
  425. // SignAndSendTransaction was renamed to SendTransaction. This method is deprecated
  426. // and will be removed in the future. It primary goal is to give clients time to update.
  427. func (s *PrivateAccountAPI) SignAndSendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
  428. return s.SendTransaction(ctx, args, passwd)
  429. }
  430. // PublicBlockChainAPI provides an API to access the Ethereum blockchain.
  431. // It offers only methods that operate on public data that is freely available to anyone.
  432. type PublicBlockChainAPI struct {
  433. b Backend
  434. }
  435. // NewPublicBlockChainAPI creates a new Ethereum blockchain API.
  436. func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI {
  437. return &PublicBlockChainAPI{b}
  438. }
  439. // BlockNumber returns the block number of the chain head.
  440. func (s *PublicBlockChainAPI) BlockNumber() hexutil.Uint64 {
  441. header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available
  442. return hexutil.Uint64(header.Number.Uint64())
  443. }
  444. // GetBalance returns the amount of wei for the given address in the state of the
  445. // given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta
  446. // block numbers are also allowed.
  447. func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Big, error) {
  448. state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
  449. if state == nil || err != nil {
  450. return nil, err
  451. }
  452. return (*hexutil.Big)(state.GetBalance(address)), state.Error()
  453. }
  454. // Result structs for GetProof
  455. type AccountResult struct {
  456. Address common.Address `json:"address"`
  457. AccountProof []string `json:"accountProof"`
  458. Balance *hexutil.Big `json:"balance"`
  459. CodeHash common.Hash `json:"codeHash"`
  460. Nonce hexutil.Uint64 `json:"nonce"`
  461. StorageHash common.Hash `json:"storageHash"`
  462. StorageProof []StorageResult `json:"storageProof"`
  463. }
  464. type StorageResult struct {
  465. Key string `json:"key"`
  466. Value *hexutil.Big `json:"value"`
  467. Proof []string `json:"proof"`
  468. }
  469. // GetProof returns the Merkle-proof for a given account and optionally some storage keys.
  470. func (s *PublicBlockChainAPI) GetProof(ctx context.Context, address common.Address, storageKeys []string, blockNr rpc.BlockNumber) (*AccountResult, error) {
  471. state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
  472. if state == nil || err != nil {
  473. return nil, err
  474. }
  475. storageTrie := state.StorageTrie(address)
  476. storageHash := types.EmptyRootHash
  477. codeHash := state.GetCodeHash(address)
  478. storageProof := make([]StorageResult, len(storageKeys))
  479. // if we have a storageTrie, (which means the account exists), we can update the storagehash
  480. if storageTrie != nil {
  481. storageHash = storageTrie.Hash()
  482. } else {
  483. // no storageTrie means the account does not exist, so the codeHash is the hash of an empty bytearray.
  484. codeHash = crypto.Keccak256Hash(nil)
  485. }
  486. // create the proof for the storageKeys
  487. for i, key := range storageKeys {
  488. if storageTrie != nil {
  489. proof, storageError := state.GetStorageProof(address, common.HexToHash(key))
  490. if storageError != nil {
  491. return nil, storageError
  492. }
  493. storageProof[i] = StorageResult{key, (*hexutil.Big)(state.GetState(address, common.HexToHash(key)).Big()), common.ToHexArray(proof)}
  494. } else {
  495. storageProof[i] = StorageResult{key, &hexutil.Big{}, []string{}}
  496. }
  497. }
  498. // create the accountProof
  499. accountProof, proofErr := state.GetProof(address)
  500. if proofErr != nil {
  501. return nil, proofErr
  502. }
  503. return &AccountResult{
  504. Address: address,
  505. AccountProof: common.ToHexArray(accountProof),
  506. Balance: (*hexutil.Big)(state.GetBalance(address)),
  507. CodeHash: codeHash,
  508. Nonce: hexutil.Uint64(state.GetNonce(address)),
  509. StorageHash: storageHash,
  510. StorageProof: storageProof,
  511. }, state.Error()
  512. }
  513. // GetBlockByNumber returns the requested block. When blockNr is -1 the chain head is returned. When fullTx is true all
  514. // transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
  515. func (s *PublicBlockChainAPI) GetBlockByNumber(ctx context.Context, blockNr rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) {
  516. block, err := s.b.BlockByNumber(ctx, blockNr)
  517. if block != nil {
  518. response, err := s.rpcOutputBlock(block, true, fullTx)
  519. if err == nil && blockNr == rpc.PendingBlockNumber {
  520. // Pending blocks need to nil out a few fields
  521. for _, field := range []string{"hash", "nonce", "miner"} {
  522. response[field] = nil
  523. }
  524. }
  525. return response, err
  526. }
  527. return nil, err
  528. }
  529. // GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full
  530. // detail, otherwise only the transaction hash is returned.
  531. func (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, blockHash common.Hash, fullTx bool) (map[string]interface{}, error) {
  532. block, err := s.b.GetBlock(ctx, blockHash)
  533. if block != nil {
  534. return s.rpcOutputBlock(block, true, fullTx)
  535. }
  536. return nil, err
  537. }
  538. // GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true
  539. // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
  540. func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {
  541. block, err := s.b.BlockByNumber(ctx, blockNr)
  542. if block != nil {
  543. uncles := block.Uncles()
  544. if index >= hexutil.Uint(len(uncles)) {
  545. log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index)
  546. return nil, nil
  547. }
  548. block = types.NewBlockWithHeader(uncles[index])
  549. return s.rpcOutputBlock(block, false, false)
  550. }
  551. return nil, err
  552. }
  553. // GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true
  554. // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
  555. func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {
  556. block, err := s.b.GetBlock(ctx, blockHash)
  557. if block != nil {
  558. uncles := block.Uncles()
  559. if index >= hexutil.Uint(len(uncles)) {
  560. log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index)
  561. return nil, nil
  562. }
  563. block = types.NewBlockWithHeader(uncles[index])
  564. return s.rpcOutputBlock(block, false, false)
  565. }
  566. return nil, err
  567. }
  568. // GetUncleCountByBlockNumber returns number of uncles in the block for the given block number
  569. func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
  570. if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
  571. n := hexutil.Uint(len(block.Uncles()))
  572. return &n
  573. }
  574. return nil
  575. }
  576. // GetUncleCountByBlockHash returns number of uncles in the block for the given block hash
  577. func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
  578. if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
  579. n := hexutil.Uint(len(block.Uncles()))
  580. return &n
  581. }
  582. return nil
  583. }
  584. // GetCode returns the code stored at the given address in the state for the given block number.
  585. func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
  586. state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
  587. if state == nil || err != nil {
  588. return nil, err
  589. }
  590. code := state.GetCode(address)
  591. return code, state.Error()
  592. }
  593. // GetStorageAt returns the storage from the state at the given address, key and
  594. // block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block
  595. // numbers are also allowed.
  596. func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
  597. state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
  598. if state == nil || err != nil {
  599. return nil, err
  600. }
  601. res := state.GetState(address, common.HexToHash(key))
  602. return res[:], state.Error()
  603. }
  604. // CallArgs represents the arguments for a call.
  605. type CallArgs struct {
  606. From *common.Address `json:"from"`
  607. To *common.Address `json:"to"`
  608. Gas *hexutil.Uint64 `json:"gas"`
  609. GasPrice *hexutil.Big `json:"gasPrice"`
  610. Value *hexutil.Big `json:"value"`
  611. Data *hexutil.Bytes `json:"data"`
  612. }
  613. func DoCall(ctx context.Context, b Backend, args CallArgs, blockNr rpc.BlockNumber, vmCfg vm.Config, timeout time.Duration, globalGasCap *big.Int) ([]byte, uint64, bool, error) {
  614. defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now())
  615. state, header, err := b.StateAndHeaderByNumber(ctx, blockNr)
  616. if state == nil || err != nil {
  617. return nil, 0, false, err
  618. }
  619. // Set sender address or use a default if none specified
  620. var addr common.Address
  621. if args.From == nil {
  622. if wallets := b.AccountManager().Wallets(); len(wallets) > 0 {
  623. if accounts := wallets[0].Accounts(); len(accounts) > 0 {
  624. addr = accounts[0].Address
  625. }
  626. }
  627. } else {
  628. addr = *args.From
  629. }
  630. // Set default gas & gas price if none were set
  631. gas := uint64(math.MaxUint64 / 2)
  632. if args.Gas != nil {
  633. gas = uint64(*args.Gas)
  634. }
  635. if globalGasCap != nil && globalGasCap.Uint64() < gas {
  636. log.Warn("Caller gas above allowance, capping", "requested", gas, "cap", globalGasCap)
  637. gas = globalGasCap.Uint64()
  638. }
  639. gasPrice := new(big.Int).SetUint64(defaultGasPrice)
  640. if args.GasPrice != nil {
  641. gasPrice = args.GasPrice.ToInt()
  642. }
  643. value := new(big.Int)
  644. if args.Value != nil {
  645. value = args.Value.ToInt()
  646. }
  647. var data []byte
  648. if args.Data != nil {
  649. data = []byte(*args.Data)
  650. }
  651. // Create new call message
  652. msg := types.NewMessage(addr, args.To, 0, value, gas, gasPrice, data, false)
  653. // Setup context so it may be cancelled the call has completed
  654. // or, in case of unmetered gas, setup a context with a timeout.
  655. var cancel context.CancelFunc
  656. if timeout > 0 {
  657. ctx, cancel = context.WithTimeout(ctx, timeout)
  658. } else {
  659. ctx, cancel = context.WithCancel(ctx)
  660. }
  661. // Make sure the context is cancelled when the call has completed
  662. // this makes sure resources are cleaned up.
  663. defer cancel()
  664. // Get a new instance of the EVM.
  665. evm, vmError, err := b.GetEVM(ctx, msg, state, header)
  666. if err != nil {
  667. return nil, 0, false, err
  668. }
  669. // Wait for the context to be done and cancel the evm. Even if the
  670. // EVM has finished, cancelling may be done (repeatedly)
  671. go func() {
  672. <-ctx.Done()
  673. evm.Cancel()
  674. }()
  675. // Setup the gas pool (also for unmetered requests)
  676. // and apply the message.
  677. gp := new(core.GasPool).AddGas(math.MaxUint64)
  678. res, gas, failed, err := core.ApplyMessage(evm, msg, gp)
  679. if err := vmError(); err != nil {
  680. return nil, 0, false, err
  681. }
  682. return res, gas, failed, err
  683. }
  684. // Call executes the given transaction on the state for the given block number.
  685. // It doesn't make and changes in the state/blockchain and is useful to execute and retrieve values.
  686. func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNr rpc.BlockNumber) (hexutil.Bytes, error) {
  687. result, _, _, err := DoCall(ctx, s.b, args, blockNr, vm.Config{}, 5*time.Second, s.b.RPCGasCap())
  688. return (hexutil.Bytes)(result), err
  689. }
  690. func DoEstimateGas(ctx context.Context, b Backend, args CallArgs, blockNr rpc.BlockNumber, gasCap *big.Int) (hexutil.Uint64, error) {
  691. // Binary search the gas requirement, as it may be higher than the amount used
  692. var (
  693. lo uint64 = params.TxGas - 1
  694. hi uint64
  695. cap uint64
  696. )
  697. if args.Gas != nil && uint64(*args.Gas) >= params.TxGas {
  698. hi = uint64(*args.Gas)
  699. } else {
  700. // Retrieve the block to act as the gas ceiling
  701. block, err := b.BlockByNumber(ctx, blockNr)
  702. if err != nil {
  703. return 0, err
  704. }
  705. hi = block.GasLimit()
  706. }
  707. if gasCap != nil && hi > gasCap.Uint64() {
  708. log.Warn("Caller gas above allowance, capping", "requested", hi, "cap", gasCap)
  709. hi = gasCap.Uint64()
  710. }
  711. cap = hi
  712. // Create a helper to check if a gas allowance results in an executable transaction
  713. executable := func(gas uint64) bool {
  714. args.Gas = (*hexutil.Uint64)(&gas)
  715. _, _, failed, err := DoCall(ctx, b, args, rpc.PendingBlockNumber, vm.Config{}, 0, gasCap)
  716. if err != nil || failed {
  717. return false
  718. }
  719. return true
  720. }
  721. // Execute the binary search and hone in on an executable gas limit
  722. for lo+1 < hi {
  723. mid := (hi + lo) / 2
  724. if !executable(mid) {
  725. lo = mid
  726. } else {
  727. hi = mid
  728. }
  729. }
  730. // Reject the transaction as invalid if it still fails at the highest allowance
  731. if hi == cap {
  732. if !executable(hi) {
  733. return 0, fmt.Errorf("gas required exceeds allowance (%d) or always failing transaction", cap)
  734. }
  735. }
  736. return hexutil.Uint64(hi), nil
  737. }
  738. // EstimateGas returns an estimate of the amount of gas needed to execute the
  739. // given transaction against the current pending block.
  740. func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (hexutil.Uint64, error) {
  741. return DoEstimateGas(ctx, s.b, args, rpc.PendingBlockNumber, s.b.RPCGasCap())
  742. }
  743. // ExecutionResult groups all structured logs emitted by the EVM
  744. // while replaying a transaction in debug mode as well as transaction
  745. // execution status, the amount of gas used and the return value
  746. type ExecutionResult struct {
  747. Gas uint64 `json:"gas"`
  748. Failed bool `json:"failed"`
  749. ReturnValue string `json:"returnValue"`
  750. StructLogs []StructLogRes `json:"structLogs"`
  751. }
  752. // StructLogRes stores a structured log emitted by the EVM while replaying a
  753. // transaction in debug mode
  754. type StructLogRes struct {
  755. Pc uint64 `json:"pc"`
  756. Op string `json:"op"`
  757. Gas uint64 `json:"gas"`
  758. GasCost uint64 `json:"gasCost"`
  759. Depth int `json:"depth"`
  760. Error error `json:"error,omitempty"`
  761. Stack *[]string `json:"stack,omitempty"`
  762. Memory *[]string `json:"memory,omitempty"`
  763. Storage *map[string]string `json:"storage,omitempty"`
  764. }
  765. // FormatLogs formats EVM returned structured logs for json output
  766. func FormatLogs(logs []vm.StructLog) []StructLogRes {
  767. formatted := make([]StructLogRes, len(logs))
  768. for index, trace := range logs {
  769. formatted[index] = StructLogRes{
  770. Pc: trace.Pc,
  771. Op: trace.Op.String(),
  772. Gas: trace.Gas,
  773. GasCost: trace.GasCost,
  774. Depth: trace.Depth,
  775. Error: trace.Err,
  776. }
  777. if trace.Stack != nil {
  778. stack := make([]string, len(trace.Stack))
  779. for i, stackValue := range trace.Stack {
  780. stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32))
  781. }
  782. formatted[index].Stack = &stack
  783. }
  784. if trace.Memory != nil {
  785. memory := make([]string, 0, (len(trace.Memory)+31)/32)
  786. for i := 0; i+32 <= len(trace.Memory); i += 32 {
  787. memory = append(memory, fmt.Sprintf("%x", trace.Memory[i:i+32]))
  788. }
  789. formatted[index].Memory = &memory
  790. }
  791. if trace.Storage != nil {
  792. storage := make(map[string]string)
  793. for i, storageValue := range trace.Storage {
  794. storage[fmt.Sprintf("%x", i)] = fmt.Sprintf("%x", storageValue)
  795. }
  796. formatted[index].Storage = &storage
  797. }
  798. }
  799. return formatted
  800. }
  801. // RPCMarshalBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are
  802. // returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain
  803. // transaction hashes.
  804. func RPCMarshalBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
  805. head := b.Header() // copies the header once
  806. fields := map[string]interface{}{
  807. "number": (*hexutil.Big)(head.Number),
  808. "hash": b.Hash(),
  809. "parentHash": head.ParentHash,
  810. "nonce": head.Nonce,
  811. "mixHash": head.MixDigest,
  812. "sha3Uncles": head.UncleHash,
  813. "logsBloom": head.Bloom,
  814. "stateRoot": head.Root,
  815. "miner": head.Coinbase,
  816. "difficulty": (*hexutil.Big)(head.Difficulty),
  817. "extraData": hexutil.Bytes(head.Extra),
  818. "size": hexutil.Uint64(b.Size()),
  819. "gasLimit": hexutil.Uint64(head.GasLimit),
  820. "gasUsed": hexutil.Uint64(head.GasUsed),
  821. "timestamp": hexutil.Uint64(head.Time),
  822. "transactionsRoot": head.TxHash,
  823. "receiptsRoot": head.ReceiptHash,
  824. }
  825. if inclTx {
  826. formatTx := func(tx *types.Transaction) (interface{}, error) {
  827. return tx.Hash(), nil
  828. }
  829. if fullTx {
  830. formatTx = func(tx *types.Transaction) (interface{}, error) {
  831. return newRPCTransactionFromBlockHash(b, tx.Hash()), nil
  832. }
  833. }
  834. txs := b.Transactions()
  835. transactions := make([]interface{}, len(txs))
  836. var err error
  837. for i, tx := range txs {
  838. if transactions[i], err = formatTx(tx); err != nil {
  839. return nil, err
  840. }
  841. }
  842. fields["transactions"] = transactions
  843. }
  844. uncles := b.Uncles()
  845. uncleHashes := make([]common.Hash, len(uncles))
  846. for i, uncle := range uncles {
  847. uncleHashes[i] = uncle.Hash()
  848. }
  849. fields["uncles"] = uncleHashes
  850. return fields, nil
  851. }
  852. // rpcOutputBlock uses the generalized output filler, then adds the total difficulty field, which requires
  853. // a `PublicBlockchainAPI`.
  854. func (s *PublicBlockChainAPI) rpcOutputBlock(b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
  855. fields, err := RPCMarshalBlock(b, inclTx, fullTx)
  856. if err != nil {
  857. return nil, err
  858. }
  859. fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(b.Hash()))
  860. return fields, err
  861. }
  862. // RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction
  863. type RPCTransaction struct {
  864. BlockHash common.Hash `json:"blockHash"`
  865. BlockNumber *hexutil.Big `json:"blockNumber"`
  866. From common.Address `json:"from"`
  867. Gas hexutil.Uint64 `json:"gas"`
  868. GasPrice *hexutil.Big `json:"gasPrice"`
  869. Hash common.Hash `json:"hash"`
  870. Input hexutil.Bytes `json:"input"`
  871. Nonce hexutil.Uint64 `json:"nonce"`
  872. To *common.Address `json:"to"`
  873. TransactionIndex hexutil.Uint `json:"transactionIndex"`
  874. Value *hexutil.Big `json:"value"`
  875. V *hexutil.Big `json:"v"`
  876. R *hexutil.Big `json:"r"`
  877. S *hexutil.Big `json:"s"`
  878. }
  879. // newRPCTransaction returns a transaction that will serialize to the RPC
  880. // representation, with the given location metadata set (if available).
  881. func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64) *RPCTransaction {
  882. var signer types.Signer = types.FrontierSigner{}
  883. if tx.Protected() {
  884. signer = types.NewEIP155Signer(tx.ChainId())
  885. }
  886. from, _ := types.Sender(signer, tx)
  887. v, r, s := tx.RawSignatureValues()
  888. result := &RPCTransaction{
  889. From: from,
  890. Gas: hexutil.Uint64(tx.Gas()),
  891. GasPrice: (*hexutil.Big)(tx.GasPrice()),
  892. Hash: tx.Hash(),
  893. Input: hexutil.Bytes(tx.Data()),
  894. Nonce: hexutil.Uint64(tx.Nonce()),
  895. To: tx.To(),
  896. Value: (*hexutil.Big)(tx.Value()),
  897. V: (*hexutil.Big)(v),
  898. R: (*hexutil.Big)(r),
  899. S: (*hexutil.Big)(s),
  900. }
  901. if blockHash != (common.Hash{}) {
  902. result.BlockHash = blockHash
  903. result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber))
  904. result.TransactionIndex = hexutil.Uint(index)
  905. }
  906. return result
  907. }
  908. // newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation
  909. func newRPCPendingTransaction(tx *types.Transaction) *RPCTransaction {
  910. return newRPCTransaction(tx, common.Hash{}, 0, 0)
  911. }
  912. // newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation.
  913. func newRPCTransactionFromBlockIndex(b *types.Block, index uint64) *RPCTransaction {
  914. txs := b.Transactions()
  915. if index >= uint64(len(txs)) {
  916. return nil
  917. }
  918. return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index)
  919. }
  920. // newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index.
  921. func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes {
  922. txs := b.Transactions()
  923. if index >= uint64(len(txs)) {
  924. return nil
  925. }
  926. blob, _ := rlp.EncodeToBytes(txs[index])
  927. return blob
  928. }
  929. // newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
  930. func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction {
  931. for idx, tx := range b.Transactions() {
  932. if tx.Hash() == hash {
  933. return newRPCTransactionFromBlockIndex(b, uint64(idx))
  934. }
  935. }
  936. return nil
  937. }
  938. // PublicTransactionPoolAPI exposes methods for the RPC interface
  939. type PublicTransactionPoolAPI struct {
  940. b Backend
  941. nonceLock *AddrLocker
  942. }
  943. // NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
  944. func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI {
  945. return &PublicTransactionPoolAPI{b, nonceLock}
  946. }
  947. // GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
  948. func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
  949. if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
  950. n := hexutil.Uint(len(block.Transactions()))
  951. return &n
  952. }
  953. return nil
  954. }
  955. // GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
  956. func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
  957. if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
  958. n := hexutil.Uint(len(block.Transactions()))
  959. return &n
  960. }
  961. return nil
  962. }
  963. // GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
  964. func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
  965. if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
  966. return newRPCTransactionFromBlockIndex(block, uint64(index))
  967. }
  968. return nil
  969. }
  970. // GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
  971. func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
  972. if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
  973. return newRPCTransactionFromBlockIndex(block, uint64(index))
  974. }
  975. return nil
  976. }
  977. // GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
  978. func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
  979. if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
  980. return newRPCRawTransactionFromBlockIndex(block, uint64(index))
  981. }
  982. return nil
  983. }
  984. // GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
  985. func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
  986. if block, _ := s.b.GetBlock(ctx, blockHash); block != nil {
  987. return newRPCRawTransactionFromBlockIndex(block, uint64(index))
  988. }
  989. return nil
  990. }
  991. // GetTransactionCount returns the number of transactions the given address has sent for the given block number
  992. func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) {
  993. // Ask transaction pool for the nonce which includes pending transactions
  994. if blockNr == rpc.PendingBlockNumber {
  995. nonce, err := s.b.GetPoolNonce(ctx, address)
  996. if err != nil {
  997. return nil, err
  998. }
  999. return (*hexutil.Uint64)(&nonce), nil
  1000. }
  1001. // Resolve block number and use its state to ask for the nonce
  1002. state, _, err := s.b.StateAndHeaderByNumber(ctx, blockNr)
  1003. if state == nil || err != nil {
  1004. return nil, err
  1005. }
  1006. nonce := state.GetNonce(address)
  1007. return (*hexutil.Uint64)(&nonce), state.Error()
  1008. }
  1009. // GetTransactionByHash returns the transaction for the given hash
  1010. func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) *RPCTransaction {
  1011. // Try to return an already finalized transaction
  1012. if tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash); tx != nil {
  1013. return newRPCTransaction(tx, blockHash, blockNumber, index)
  1014. }
  1015. // No finalized transaction, try to retrieve it from the pool
  1016. if tx := s.b.GetPoolTransaction(hash); tx != nil {
  1017. return newRPCPendingTransaction(tx)
  1018. }
  1019. // Transaction unknown, return as such
  1020. return nil
  1021. }
  1022. // GetRawTransactionByHash returns the bytes of the transaction for the given hash.
  1023. func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
  1024. var tx *types.Transaction
  1025. // Retrieve a finalized transaction, or a pooled otherwise
  1026. if tx, _, _, _ = rawdb.ReadTransaction(s.b.ChainDb(), hash); tx == nil {
  1027. if tx = s.b.GetPoolTransaction(hash); tx == nil {
  1028. // Transaction not found anywhere, abort
  1029. return nil, nil
  1030. }
  1031. }
  1032. // Serialize to RLP and return
  1033. return rlp.EncodeToBytes(tx)
  1034. }
  1035. // GetTransactionReceipt returns the transaction receipt for the given transaction hash.
  1036. func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {
  1037. tx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash)
  1038. if tx == nil {
  1039. return nil, nil
  1040. }
  1041. receipts, err := s.b.GetReceipts(ctx, blockHash)
  1042. if err != nil {
  1043. return nil, err
  1044. }
  1045. if len(receipts) <= int(index) {
  1046. return nil, nil
  1047. }
  1048. receipt := receipts[index]
  1049. var signer types.Signer = types.FrontierSigner{}
  1050. if tx.Protected() {
  1051. signer = types.NewEIP155Signer(tx.ChainId())
  1052. }
  1053. from, _ := types.Sender(signer, tx)
  1054. fields := map[string]interface{}{
  1055. "blockHash": blockHash,
  1056. "blockNumber": hexutil.Uint64(blockNumber),
  1057. "transactionHash": hash,
  1058. "transactionIndex": hexutil.Uint64(index),
  1059. "from": from,
  1060. "to": tx.To(),
  1061. "gasUsed": hexutil.Uint64(receipt.GasUsed),
  1062. "cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed),
  1063. "contractAddress": nil,
  1064. "logs": receipt.Logs,
  1065. "logsBloom": receipt.Bloom,
  1066. }
  1067. // Assign receipt status or post state.
  1068. if len(receipt.PostState) > 0 {
  1069. fields["root"] = hexutil.Bytes(receipt.PostState)
  1070. } else {
  1071. fields["status"] = hexutil.Uint(receipt.Status)
  1072. }
  1073. if receipt.Logs == nil {
  1074. fields["logs"] = [][]*types.Log{}
  1075. }
  1076. // If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
  1077. if receipt.ContractAddress != (common.Address{}) {
  1078. fields["contractAddress"] = receipt.ContractAddress
  1079. }
  1080. return fields, nil
  1081. }
  1082. // sign is a helper function that signs a transaction with the private key of the given address.
  1083. func (s *PublicTransactionPoolAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) {
  1084. // Look up the wallet containing the requested signer
  1085. account := accounts.Account{Address: addr}
  1086. wallet, err := s.b.AccountManager().Find(account)
  1087. if err != nil {
  1088. return nil, err
  1089. }
  1090. // Request the wallet to sign the transaction
  1091. return wallet.SignTx(account, tx, s.b.ChainConfig().ChainID)
  1092. }
  1093. // SendTxArgs represents the arguments to sumbit a new transaction into the transaction pool.
  1094. type SendTxArgs struct {
  1095. From common.Address `json:"from"`
  1096. To *common.Address `json:"to"`
  1097. Gas *hexutil.Uint64 `json:"gas"`
  1098. GasPrice *hexutil.Big `json:"gasPrice"`
  1099. Value *hexutil.Big `json:"value"`
  1100. Nonce *hexutil.Uint64 `json:"nonce"`
  1101. // We accept "data" and "input" for backwards-compatibility reasons. "input" is the
  1102. // newer name and should be preferred by clients.
  1103. Data *hexutil.Bytes `json:"data"`
  1104. Input *hexutil.Bytes `json:"input"`
  1105. }
  1106. // setDefaults is a helper function that fills in default values for unspecified tx fields.
  1107. func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
  1108. if args.Gas == nil {
  1109. args.Gas = new(hexutil.Uint64)
  1110. *(*uint64)(args.Gas) = 90000
  1111. }
  1112. if args.GasPrice == nil {
  1113. price, err := b.SuggestPrice(ctx)
  1114. if err != nil {
  1115. return err
  1116. }
  1117. args.GasPrice = (*hexutil.Big)(price)
  1118. }
  1119. if args.Value == nil {
  1120. args.Value = new(hexutil.Big)
  1121. }
  1122. if args.Nonce == nil {
  1123. nonce, err := b.GetPoolNonce(ctx, args.From)
  1124. if err != nil {
  1125. return err
  1126. }
  1127. args.Nonce = (*hexutil.Uint64)(&nonce)
  1128. }
  1129. if args.Data != nil && args.Input != nil && !bytes.Equal(*args.Data, *args.Input) {
  1130. return errors.New(`Both "data" and "input" are set and not equal. Please use "input" to pass transaction call data.`)
  1131. }
  1132. if args.To == nil {
  1133. // Contract creation
  1134. var input []byte
  1135. if args.Data != nil {
  1136. input = *args.Data
  1137. } else if args.Input != nil {
  1138. input = *args.Input
  1139. }
  1140. if len(input) == 0 {
  1141. return errors.New(`contract creation without any data provided`)
  1142. }
  1143. }
  1144. return nil
  1145. }
  1146. func (args *SendTxArgs) toTransaction() *types.Transaction {
  1147. var input []byte
  1148. if args.Data != nil {
  1149. input = *args.Data
  1150. } else if args.Input != nil {
  1151. input = *args.Input
  1152. }
  1153. if args.To == nil {
  1154. return types.NewContractCreation(uint64(*args.Nonce), (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
  1155. }
  1156. return types.NewTransaction(uint64(*args.Nonce), *args.To, (*big.Int)(args.Value), uint64(*args.Gas), (*big.Int)(args.GasPrice), input)
  1157. }
  1158. // SubmitTransaction is a helper function that submits tx to txPool and logs a message.
  1159. func SubmitTransaction(ctx context.Context, b Backend, tx *types.Transaction) (common.Hash, error) {
  1160. if err := b.SendTx(ctx, tx); err != nil {
  1161. return common.Hash{}, err
  1162. }
  1163. if tx.To() == nil {
  1164. signer := types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
  1165. from, err := types.Sender(signer, tx)
  1166. if err != nil {
  1167. return common.Hash{}, err
  1168. }
  1169. addr := crypto.CreateAddress(from, tx.Nonce())
  1170. log.Info("Submitted contract creation", "fullhash", tx.Hash().Hex(), "contract", addr.Hex())
  1171. } else {
  1172. log.Info("Submitted transaction", "fullhash", tx.Hash().Hex(), "recipient", tx.To())
  1173. }
  1174. return tx.Hash(), nil
  1175. }
  1176. // SendTransaction creates a transaction for the given argument, sign it and submit it to the
  1177. // transaction pool.
  1178. func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args SendTxArgs) (common.Hash, error) {
  1179. // Look up the wallet containing the requested signer
  1180. account := accounts.Account{Address: args.From}
  1181. wallet, err := s.b.AccountManager().Find(account)
  1182. if err != nil {
  1183. return common.Hash{}, err
  1184. }
  1185. if args.Nonce == nil {
  1186. // Hold the addresse's mutex around signing to prevent concurrent assignment of
  1187. // the same nonce to multiple accounts.
  1188. s.nonceLock.LockAddr(args.From)
  1189. defer s.nonceLock.UnlockAddr(args.From)
  1190. }
  1191. // Set some sanity defaults and terminate on failure
  1192. if err := args.setDefaults(ctx, s.b); err != nil {
  1193. return common.Hash{}, err
  1194. }
  1195. // Assemble the transaction and sign with the wallet
  1196. tx := args.toTransaction()
  1197. signed, err := wallet.SignTx(account, tx, s.b.ChainConfig().ChainID)
  1198. if err != nil {
  1199. return common.Hash{}, err
  1200. }
  1201. return SubmitTransaction(ctx, s.b, signed)
  1202. }
  1203. // SendRawTransaction will add the signed transaction to the transaction pool.
  1204. // The sender is responsible for signing the transaction and using the correct nonce.
  1205. func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) {
  1206. tx := new(types.Transaction)
  1207. if err := rlp.DecodeBytes(encodedTx, tx); err != nil {
  1208. return common.Hash{}, err
  1209. }
  1210. return SubmitTransaction(ctx, s.b, tx)
  1211. }
  1212. // Sign calculates an ECDSA signature for:
  1213. // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
  1214. //
  1215. // Note, the produced signature conforms to the secp256k1 curve R, S and V values,
  1216. // where the V value will be 27 or 28 for legacy reasons.
  1217. //
  1218. // The account associated with addr must be unlocked.
  1219. //
  1220. // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
  1221. func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
  1222. // Look up the wallet containing the requested signer
  1223. account := accounts.Account{Address: addr}
  1224. wallet, err := s.b.AccountManager().Find(account)
  1225. if err != nil {
  1226. return nil, err
  1227. }
  1228. // Sign the requested hash with the wallet
  1229. signature, err := wallet.SignText(account, data)
  1230. if err == nil {
  1231. signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
  1232. }
  1233. return signature, err
  1234. }
  1235. // SignTransactionResult represents a RLP encoded signed transaction.
  1236. type SignTransactionResult struct {
  1237. Raw hexutil.Bytes `json:"raw"`
  1238. Tx *types.Transaction `json:"tx"`
  1239. }
  1240. // SignTransaction will sign the given transaction with the from account.
  1241. // The node needs to have the private key of the account corresponding with
  1242. // the given from address and it needs to be unlocked.
  1243. func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
  1244. if args.Gas == nil {
  1245. return nil, fmt.Errorf("gas not specified")
  1246. }
  1247. if args.GasPrice == nil {
  1248. return nil, fmt.Errorf("gasPrice not specified")
  1249. }
  1250. if args.Nonce == nil {
  1251. return nil, fmt.Errorf("nonce not specified")
  1252. }
  1253. if err := args.setDefaults(ctx, s.b); err != nil {
  1254. return nil, err
  1255. }
  1256. tx, err := s.sign(args.From, args.toTransaction())
  1257. if err != nil {
  1258. return nil, err
  1259. }
  1260. data, err := rlp.EncodeToBytes(tx)
  1261. if err != nil {
  1262. return nil, err
  1263. }
  1264. return &SignTransactionResult{data, tx}, nil
  1265. }
  1266. // PendingTransactions returns the transactions that are in the transaction pool
  1267. // and have a from address that is one of the accounts this node manages.
  1268. func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
  1269. pending, err := s.b.GetPoolTransactions()
  1270. if err != nil {
  1271. return nil, err
  1272. }
  1273. accounts := make(map[common.Address]struct{})
  1274. for _, wallet := range s.b.AccountManager().Wallets() {
  1275. for _, account := range wallet.Accounts() {
  1276. accounts[account.Address] = struct{}{}
  1277. }
  1278. }
  1279. transactions := make([]*RPCTransaction, 0, len(pending))
  1280. for _, tx := range pending {
  1281. var signer types.Signer = types.HomesteadSigner{}
  1282. if tx.Protected() {
  1283. signer = types.NewEIP155Signer(tx.ChainId())
  1284. }
  1285. from, _ := types.Sender(signer, tx)
  1286. if _, exists := accounts[from]; exists {
  1287. transactions = append(transactions, newRPCPendingTransaction(tx))
  1288. }
  1289. }
  1290. return transactions, nil
  1291. }
  1292. // Resend accepts an existing transaction and a new gas price and limit. It will remove
  1293. // the given transaction from the pool and reinsert it with the new gas price and limit.
  1294. func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {
  1295. if sendArgs.Nonce == nil {
  1296. return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec")
  1297. }
  1298. if err := sendArgs.setDefaults(ctx, s.b); err != nil {
  1299. return common.Hash{}, err
  1300. }
  1301. matchTx := sendArgs.toTransaction()
  1302. pending, err := s.b.GetPoolTransactions()
  1303. if err != nil {
  1304. return common.Hash{}, err
  1305. }
  1306. for _, p := range pending {
  1307. var signer types.Signer = types.HomesteadSigner{}
  1308. if p.Protected() {
  1309. signer = types.NewEIP155Signer(p.ChainId())
  1310. }
  1311. wantSigHash := signer.Hash(matchTx)
  1312. if pFrom, err := types.Sender(signer, p); err == nil && pFrom == sendArgs.From && signer.Hash(p) == wantSigHash {
  1313. // Match. Re-sign and send the transaction.
  1314. if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 {
  1315. sendArgs.GasPrice = gasPrice
  1316. }
  1317. if gasLimit != nil && *gasLimit != 0 {
  1318. sendArgs.Gas = gasLimit
  1319. }
  1320. signedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())
  1321. if err != nil {
  1322. return common.Hash{}, err
  1323. }
  1324. if err = s.b.SendTx(ctx, signedTx); err != nil {
  1325. return common.Hash{}, err
  1326. }
  1327. return signedTx.Hash(), nil
  1328. }
  1329. }
  1330. return common.Hash{}, fmt.Errorf("Transaction %#x not found", matchTx.Hash())
  1331. }
  1332. // PublicDebugAPI is the collection of Ethereum APIs exposed over the public
  1333. // debugging endpoint.
  1334. type PublicDebugAPI struct {
  1335. b Backend
  1336. }
  1337. // NewPublicDebugAPI creates a new API definition for the public debug methods
  1338. // of the Ethereum service.
  1339. func NewPublicDebugAPI(b Backend) *PublicDebugAPI {
  1340. return &PublicDebugAPI{b: b}
  1341. }
  1342. // GetBlockRlp retrieves the RLP encoded for of a single block.
  1343. func (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) {
  1344. block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1345. if block == nil {
  1346. return "", fmt.Errorf("block #%d not found", number)
  1347. }
  1348. encoded, err := rlp.EncodeToBytes(block)
  1349. if err != nil {
  1350. return "", err
  1351. }
  1352. return fmt.Sprintf("%x", encoded), nil
  1353. }
  1354. // TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the
  1355. // given address, returning the address of the recovered signature
  1356. //
  1357. // This is a temporary method to debug the externalsigner integration,
  1358. // TODO: Remove this method when the integration is mature
  1359. func (api *PublicDebugAPI) TestSignCliqueBlock(ctx context.Context, address common.Address, number uint64) (common.Address, error) {
  1360. block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1361. if block == nil {
  1362. return common.Address{}, fmt.Errorf("block #%d not found", number)
  1363. }
  1364. header := block.Header()
  1365. header.Extra = make([]byte, 32+65)
  1366. encoded := clique.CliqueRLP(header)
  1367. // Look up the wallet containing the requested signer
  1368. account := accounts.Account{Address: address}
  1369. wallet, err := api.b.AccountManager().Find(account)
  1370. if err != nil {
  1371. return common.Address{}, err
  1372. }
  1373. signature, err := wallet.SignData(account, accounts.MimetypeClique, encoded)
  1374. if err != nil {
  1375. return common.Address{}, err
  1376. }
  1377. sealHash := clique.SealHash(header).Bytes()
  1378. log.Info("test signing of clique block",
  1379. "Sealhash", fmt.Sprintf("%x", sealHash),
  1380. "signature", fmt.Sprintf("%x", signature))
  1381. pubkey, err := crypto.Ecrecover(sealHash, signature)
  1382. if err != nil {
  1383. return common.Address{}, err
  1384. }
  1385. var signer common.Address
  1386. copy(signer[:], crypto.Keccak256(pubkey[1:])[12:])
  1387. return signer, nil
  1388. }
  1389. // PrintBlock retrieves a block and returns its pretty printed form.
  1390. func (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) {
  1391. block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1392. if block == nil {
  1393. return "", fmt.Errorf("block #%d not found", number)
  1394. }
  1395. return spew.Sdump(block), nil
  1396. }
  1397. // SeedHash retrieves the seed hash of a block.
  1398. func (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) {
  1399. block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
  1400. if block == nil {
  1401. return "", fmt.Errorf("block #%d not found", number)
  1402. }
  1403. return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil
  1404. }
  1405. // PrivateDebugAPI is the collection of Ethereum APIs exposed over the private
  1406. // debugging endpoint.
  1407. type PrivateDebugAPI struct {
  1408. b Backend
  1409. }
  1410. // NewPrivateDebugAPI creates a new API definition for the private debug methods
  1411. // of the Ethereum service.
  1412. func NewPrivateDebugAPI(b Backend) *PrivateDebugAPI {
  1413. return &PrivateDebugAPI{b: b}
  1414. }
  1415. // ChaindbProperty returns leveldb properties of the chain database.
  1416. func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) {
  1417. ldb, ok := api.b.ChainDb().(interface {
  1418. LDB() *leveldb.DB
  1419. })
  1420. if !ok {
  1421. return "", fmt.Errorf("chaindbProperty does not work for memory databases")
  1422. }
  1423. if property == "" {
  1424. property = "leveldb.stats"
  1425. } else if !strings.HasPrefix(property, "leveldb.") {
  1426. property = "leveldb." + property
  1427. }
  1428. return ldb.LDB().GetProperty(property)
  1429. }
  1430. func (api *PrivateDebugAPI) ChaindbCompact() error {
  1431. for b := byte(0); b < 255; b++ {
  1432. log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
  1433. if err := api.b.ChainDb().Compact([]byte{b}, []byte{b + 1}); err != nil {
  1434. log.Error("Database compaction failed", "err", err)
  1435. return err
  1436. }
  1437. }
  1438. return nil
  1439. }
  1440. // SetHead rewinds the head of the blockchain to a previous block.
  1441. func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
  1442. api.b.SetHead(uint64(number))
  1443. }
  1444. // PublicNetAPI offers network related RPC methods
  1445. type PublicNetAPI struct {
  1446. net *p2p.Server
  1447. networkVersion uint64
  1448. }
  1449. // NewPublicNetAPI creates a new net API instance.
  1450. func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
  1451. return &PublicNetAPI{net, networkVersion}
  1452. }
  1453. // Listening returns an indication if the node is listening for network connections.
  1454. func (s *PublicNetAPI) Listening() bool {
  1455. return true // always listening
  1456. }
  1457. // PeerCount returns the number of connected peers
  1458. func (s *PublicNetAPI) PeerCount() hexutil.Uint {
  1459. return hexutil.Uint(s.net.PeerCount())
  1460. }
  1461. // Version returns the current ethereum protocol version.
  1462. func (s *PublicNetAPI) Version() string {
  1463. return fmt.Sprintf("%d", s.networkVersion)
  1464. }