accessors_chain.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671
  1. // Copyright 2018 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 rawdb
  17. import (
  18. "bytes"
  19. "encoding/binary"
  20. "math/big"
  21. "github.com/ethereum/go-ethereum/common"
  22. "github.com/ethereum/go-ethereum/core/types"
  23. "github.com/ethereum/go-ethereum/crypto"
  24. "github.com/ethereum/go-ethereum/ethdb"
  25. "github.com/ethereum/go-ethereum/log"
  26. "github.com/ethereum/go-ethereum/params"
  27. "github.com/ethereum/go-ethereum/rlp"
  28. )
  29. // ReadCanonicalHash retrieves the hash assigned to a canonical block number.
  30. func ReadCanonicalHash(db ethdb.Reader, number uint64) common.Hash {
  31. data, _ := db.Ancient(freezerHashTable, number)
  32. if len(data) == 0 {
  33. data, _ = db.Get(headerHashKey(number))
  34. // In the background freezer is moving data from leveldb to flatten files.
  35. // So during the first check for ancient db, the data is not yet in there,
  36. // but when we reach into leveldb, the data was already moved. That would
  37. // result in a not found error.
  38. if len(data) == 0 {
  39. data, _ = db.Ancient(freezerHashTable, number)
  40. }
  41. }
  42. if len(data) == 0 {
  43. return common.Hash{}
  44. }
  45. return common.BytesToHash(data)
  46. }
  47. // WriteCanonicalHash stores the hash assigned to a canonical block number.
  48. func WriteCanonicalHash(db ethdb.KeyValueWriter, hash common.Hash, number uint64) {
  49. if err := db.Put(headerHashKey(number), hash.Bytes()); err != nil {
  50. log.Crit("Failed to store number to hash mapping", "err", err)
  51. }
  52. }
  53. // DeleteCanonicalHash removes the number to hash canonical mapping.
  54. func DeleteCanonicalHash(db ethdb.KeyValueWriter, number uint64) {
  55. if err := db.Delete(headerHashKey(number)); err != nil {
  56. log.Crit("Failed to delete number to hash mapping", "err", err)
  57. }
  58. }
  59. // ReadAllHashes retrieves all the hashes assigned to blocks at a certain heights,
  60. // both canonical and reorged forks included.
  61. func ReadAllHashes(db ethdb.Iteratee, number uint64) []common.Hash {
  62. prefix := headerKeyPrefix(number)
  63. hashes := make([]common.Hash, 0, 1)
  64. it := db.NewIterator(prefix, nil)
  65. defer it.Release()
  66. for it.Next() {
  67. if key := it.Key(); len(key) == len(prefix)+32 {
  68. hashes = append(hashes, common.BytesToHash(key[len(key)-32:]))
  69. }
  70. }
  71. return hashes
  72. }
  73. // ReadHeaderNumber returns the header number assigned to a hash.
  74. func ReadHeaderNumber(db ethdb.KeyValueReader, hash common.Hash) *uint64 {
  75. data, _ := db.Get(headerNumberKey(hash))
  76. if len(data) != 8 {
  77. return nil
  78. }
  79. number := binary.BigEndian.Uint64(data)
  80. return &number
  81. }
  82. // WriteHeaderNumber stores the hash->number mapping.
  83. func WriteHeaderNumber(db ethdb.KeyValueWriter, hash common.Hash, number uint64) {
  84. key := headerNumberKey(hash)
  85. enc := encodeBlockNumber(number)
  86. if err := db.Put(key, enc); err != nil {
  87. log.Crit("Failed to store hash to number mapping", "err", err)
  88. }
  89. }
  90. // DeleteHeaderNumber removes hash->number mapping.
  91. func DeleteHeaderNumber(db ethdb.KeyValueWriter, hash common.Hash) {
  92. if err := db.Delete(headerNumberKey(hash)); err != nil {
  93. log.Crit("Failed to delete hash to number mapping", "err", err)
  94. }
  95. }
  96. // ReadHeadHeaderHash retrieves the hash of the current canonical head header.
  97. func ReadHeadHeaderHash(db ethdb.KeyValueReader) common.Hash {
  98. data, _ := db.Get(headHeaderKey)
  99. if len(data) == 0 {
  100. return common.Hash{}
  101. }
  102. return common.BytesToHash(data)
  103. }
  104. // WriteHeadHeaderHash stores the hash of the current canonical head header.
  105. func WriteHeadHeaderHash(db ethdb.KeyValueWriter, hash common.Hash) {
  106. if err := db.Put(headHeaderKey, hash.Bytes()); err != nil {
  107. log.Crit("Failed to store last header's hash", "err", err)
  108. }
  109. }
  110. // ReadHeadBlockHash retrieves the hash of the current canonical head block.
  111. func ReadHeadBlockHash(db ethdb.KeyValueReader) common.Hash {
  112. data, _ := db.Get(headBlockKey)
  113. if len(data) == 0 {
  114. return common.Hash{}
  115. }
  116. return common.BytesToHash(data)
  117. }
  118. // WriteHeadBlockHash stores the head block's hash.
  119. func WriteHeadBlockHash(db ethdb.KeyValueWriter, hash common.Hash) {
  120. if err := db.Put(headBlockKey, hash.Bytes()); err != nil {
  121. log.Crit("Failed to store last block's hash", "err", err)
  122. }
  123. }
  124. // ReadHeadFastBlockHash retrieves the hash of the current fast-sync head block.
  125. func ReadHeadFastBlockHash(db ethdb.KeyValueReader) common.Hash {
  126. data, _ := db.Get(headFastBlockKey)
  127. if len(data) == 0 {
  128. return common.Hash{}
  129. }
  130. return common.BytesToHash(data)
  131. }
  132. // WriteHeadFastBlockHash stores the hash of the current fast-sync head block.
  133. func WriteHeadFastBlockHash(db ethdb.KeyValueWriter, hash common.Hash) {
  134. if err := db.Put(headFastBlockKey, hash.Bytes()); err != nil {
  135. log.Crit("Failed to store last fast block's hash", "err", err)
  136. }
  137. }
  138. // ReadFastTrieProgress retrieves the number of tries nodes fast synced to allow
  139. // reporting correct numbers across restarts.
  140. func ReadFastTrieProgress(db ethdb.KeyValueReader) uint64 {
  141. data, _ := db.Get(fastTrieProgressKey)
  142. if len(data) == 0 {
  143. return 0
  144. }
  145. return new(big.Int).SetBytes(data).Uint64()
  146. }
  147. // WriteFastTrieProgress stores the fast sync trie process counter to support
  148. // retrieving it across restarts.
  149. func WriteFastTrieProgress(db ethdb.KeyValueWriter, count uint64) {
  150. if err := db.Put(fastTrieProgressKey, new(big.Int).SetUint64(count).Bytes()); err != nil {
  151. log.Crit("Failed to store fast sync trie progress", "err", err)
  152. }
  153. }
  154. // ReadTxIndexTail retrieves the number of oldest indexed block
  155. // whose transaction indices has been indexed. If the corresponding entry
  156. // is non-existent in database it means the indexing has been finished.
  157. func ReadTxIndexTail(db ethdb.KeyValueReader) *uint64 {
  158. data, _ := db.Get(txIndexTailKey)
  159. if len(data) != 8 {
  160. return nil
  161. }
  162. number := binary.BigEndian.Uint64(data)
  163. return &number
  164. }
  165. // WriteTxIndexTail stores the number of oldest indexed block
  166. // into database.
  167. func WriteTxIndexTail(db ethdb.KeyValueWriter, number uint64) {
  168. if err := db.Put(txIndexTailKey, encodeBlockNumber(number)); err != nil {
  169. log.Crit("Failed to store the transaction index tail", "err", err)
  170. }
  171. }
  172. // ReadFastTxLookupLimit retrieves the tx lookup limit used in fast sync.
  173. func ReadFastTxLookupLimit(db ethdb.KeyValueReader) *uint64 {
  174. data, _ := db.Get(fastTxLookupLimitKey)
  175. if len(data) != 8 {
  176. return nil
  177. }
  178. number := binary.BigEndian.Uint64(data)
  179. return &number
  180. }
  181. // WriteFastTxLookupLimit stores the txlookup limit used in fast sync into database.
  182. func WriteFastTxLookupLimit(db ethdb.KeyValueWriter, number uint64) {
  183. if err := db.Put(fastTxLookupLimitKey, encodeBlockNumber(number)); err != nil {
  184. log.Crit("Failed to store transaction lookup limit for fast sync", "err", err)
  185. }
  186. }
  187. // ReadHeaderRLP retrieves a block header in its raw RLP database encoding.
  188. func ReadHeaderRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue {
  189. // First try to look up the data in ancient database. Extra hash
  190. // comparison is necessary since ancient database only maintains
  191. // the canonical data.
  192. data, _ := db.Ancient(freezerHeaderTable, number)
  193. if len(data) > 0 && crypto.Keccak256Hash(data) == hash {
  194. return data
  195. }
  196. // Then try to look up the data in leveldb.
  197. data, _ = db.Get(headerKey(number, hash))
  198. if len(data) > 0 {
  199. return data
  200. }
  201. // In the background freezer is moving data from leveldb to flatten files.
  202. // So during the first check for ancient db, the data is not yet in there,
  203. // but when we reach into leveldb, the data was already moved. That would
  204. // result in a not found error.
  205. data, _ = db.Ancient(freezerHeaderTable, number)
  206. if len(data) > 0 && crypto.Keccak256Hash(data) == hash {
  207. return data
  208. }
  209. return nil // Can't find the data anywhere.
  210. }
  211. // HasHeader verifies the existence of a block header corresponding to the hash.
  212. func HasHeader(db ethdb.Reader, hash common.Hash, number uint64) bool {
  213. if has, err := db.Ancient(freezerHashTable, number); err == nil && common.BytesToHash(has) == hash {
  214. return true
  215. }
  216. if has, err := db.Has(headerKey(number, hash)); !has || err != nil {
  217. return false
  218. }
  219. return true
  220. }
  221. // ReadHeader retrieves the block header corresponding to the hash.
  222. func ReadHeader(db ethdb.Reader, hash common.Hash, number uint64) *types.Header {
  223. data := ReadHeaderRLP(db, hash, number)
  224. if len(data) == 0 {
  225. return nil
  226. }
  227. header := new(types.Header)
  228. if err := rlp.Decode(bytes.NewReader(data), header); err != nil {
  229. log.Error("Invalid block header RLP", "hash", hash, "err", err)
  230. return nil
  231. }
  232. return header
  233. }
  234. // WriteHeader stores a block header into the database and also stores the hash-
  235. // to-number mapping.
  236. func WriteHeader(db ethdb.KeyValueWriter, header *types.Header) {
  237. var (
  238. hash = header.Hash()
  239. number = header.Number.Uint64()
  240. )
  241. // Write the hash -> number mapping
  242. WriteHeaderNumber(db, hash, number)
  243. // Write the encoded header
  244. data, err := rlp.EncodeToBytes(header)
  245. if err != nil {
  246. log.Crit("Failed to RLP encode header", "err", err)
  247. }
  248. key := headerKey(number, hash)
  249. if err := db.Put(key, data); err != nil {
  250. log.Crit("Failed to store header", "err", err)
  251. }
  252. }
  253. // DeleteHeader removes all block header data associated with a hash.
  254. func DeleteHeader(db ethdb.KeyValueWriter, hash common.Hash, number uint64) {
  255. deleteHeaderWithoutNumber(db, hash, number)
  256. if err := db.Delete(headerNumberKey(hash)); err != nil {
  257. log.Crit("Failed to delete hash to number mapping", "err", err)
  258. }
  259. }
  260. // deleteHeaderWithoutNumber removes only the block header but does not remove
  261. // the hash to number mapping.
  262. func deleteHeaderWithoutNumber(db ethdb.KeyValueWriter, hash common.Hash, number uint64) {
  263. if err := db.Delete(headerKey(number, hash)); err != nil {
  264. log.Crit("Failed to delete header", "err", err)
  265. }
  266. }
  267. // ReadBodyRLP retrieves the block body (transactions and uncles) in RLP encoding.
  268. func ReadBodyRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue {
  269. // First try to look up the data in ancient database. Extra hash
  270. // comparison is necessary since ancient database only maintains
  271. // the canonical data.
  272. data, _ := db.Ancient(freezerBodiesTable, number)
  273. if len(data) > 0 {
  274. h, _ := db.Ancient(freezerHashTable, number)
  275. if common.BytesToHash(h) == hash {
  276. return data
  277. }
  278. }
  279. // Then try to look up the data in leveldb.
  280. data, _ = db.Get(blockBodyKey(number, hash))
  281. if len(data) > 0 {
  282. return data
  283. }
  284. // In the background freezer is moving data from leveldb to flatten files.
  285. // So during the first check for ancient db, the data is not yet in there,
  286. // but when we reach into leveldb, the data was already moved. That would
  287. // result in a not found error.
  288. data, _ = db.Ancient(freezerBodiesTable, number)
  289. if len(data) > 0 {
  290. h, _ := db.Ancient(freezerHashTable, number)
  291. if common.BytesToHash(h) == hash {
  292. return data
  293. }
  294. }
  295. return nil // Can't find the data anywhere.
  296. }
  297. // ReadCanonicalBodyRLP retrieves the block body (transactions and uncles) for the canonical
  298. // block at number, in RLP encoding.
  299. func ReadCanonicalBodyRLP(db ethdb.Reader, number uint64) rlp.RawValue {
  300. // If it's an ancient one, we don't need the canonical hash
  301. data, _ := db.Ancient(freezerBodiesTable, number)
  302. if len(data) == 0 {
  303. // Need to get the hash
  304. data, _ = db.Get(blockBodyKey(number, ReadCanonicalHash(db, number)))
  305. // In the background freezer is moving data from leveldb to flatten files.
  306. // So during the first check for ancient db, the data is not yet in there,
  307. // but when we reach into leveldb, the data was already moved. That would
  308. // result in a not found error.
  309. if len(data) == 0 {
  310. data, _ = db.Ancient(freezerBodiesTable, number)
  311. }
  312. }
  313. return data
  314. }
  315. // WriteBodyRLP stores an RLP encoded block body into the database.
  316. func WriteBodyRLP(db ethdb.KeyValueWriter, hash common.Hash, number uint64, rlp rlp.RawValue) {
  317. if err := db.Put(blockBodyKey(number, hash), rlp); err != nil {
  318. log.Crit("Failed to store block body", "err", err)
  319. }
  320. }
  321. // HasBody verifies the existence of a block body corresponding to the hash.
  322. func HasBody(db ethdb.Reader, hash common.Hash, number uint64) bool {
  323. if has, err := db.Ancient(freezerHashTable, number); err == nil && common.BytesToHash(has) == hash {
  324. return true
  325. }
  326. if has, err := db.Has(blockBodyKey(number, hash)); !has || err != nil {
  327. return false
  328. }
  329. return true
  330. }
  331. // ReadBody retrieves the block body corresponding to the hash.
  332. func ReadBody(db ethdb.Reader, hash common.Hash, number uint64) *types.Body {
  333. data := ReadBodyRLP(db, hash, number)
  334. if len(data) == 0 {
  335. return nil
  336. }
  337. body := new(types.Body)
  338. if err := rlp.Decode(bytes.NewReader(data), body); err != nil {
  339. log.Error("Invalid block body RLP", "hash", hash, "err", err)
  340. return nil
  341. }
  342. return body
  343. }
  344. // WriteBody stores a block body into the database.
  345. func WriteBody(db ethdb.KeyValueWriter, hash common.Hash, number uint64, body *types.Body) {
  346. data, err := rlp.EncodeToBytes(body)
  347. if err != nil {
  348. log.Crit("Failed to RLP encode body", "err", err)
  349. }
  350. WriteBodyRLP(db, hash, number, data)
  351. }
  352. // DeleteBody removes all block body data associated with a hash.
  353. func DeleteBody(db ethdb.KeyValueWriter, hash common.Hash, number uint64) {
  354. if err := db.Delete(blockBodyKey(number, hash)); err != nil {
  355. log.Crit("Failed to delete block body", "err", err)
  356. }
  357. }
  358. // ReadTdRLP retrieves a block's total difficulty corresponding to the hash in RLP encoding.
  359. func ReadTdRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue {
  360. // First try to look up the data in ancient database. Extra hash
  361. // comparison is necessary since ancient database only maintains
  362. // the canonical data.
  363. data, _ := db.Ancient(freezerDifficultyTable, number)
  364. if len(data) > 0 {
  365. h, _ := db.Ancient(freezerHashTable, number)
  366. if common.BytesToHash(h) == hash {
  367. return data
  368. }
  369. }
  370. // Then try to look up the data in leveldb.
  371. data, _ = db.Get(headerTDKey(number, hash))
  372. if len(data) > 0 {
  373. return data
  374. }
  375. // In the background freezer is moving data from leveldb to flatten files.
  376. // So during the first check for ancient db, the data is not yet in there,
  377. // but when we reach into leveldb, the data was already moved. That would
  378. // result in a not found error.
  379. data, _ = db.Ancient(freezerDifficultyTable, number)
  380. if len(data) > 0 {
  381. h, _ := db.Ancient(freezerHashTable, number)
  382. if common.BytesToHash(h) == hash {
  383. return data
  384. }
  385. }
  386. return nil // Can't find the data anywhere.
  387. }
  388. // ReadTd retrieves a block's total difficulty corresponding to the hash.
  389. func ReadTd(db ethdb.Reader, hash common.Hash, number uint64) *big.Int {
  390. data := ReadTdRLP(db, hash, number)
  391. if len(data) == 0 {
  392. return nil
  393. }
  394. td := new(big.Int)
  395. if err := rlp.Decode(bytes.NewReader(data), td); err != nil {
  396. log.Error("Invalid block total difficulty RLP", "hash", hash, "err", err)
  397. return nil
  398. }
  399. return td
  400. }
  401. // WriteTd stores the total difficulty of a block into the database.
  402. func WriteTd(db ethdb.KeyValueWriter, hash common.Hash, number uint64, td *big.Int) {
  403. data, err := rlp.EncodeToBytes(td)
  404. if err != nil {
  405. log.Crit("Failed to RLP encode block total difficulty", "err", err)
  406. }
  407. if err := db.Put(headerTDKey(number, hash), data); err != nil {
  408. log.Crit("Failed to store block total difficulty", "err", err)
  409. }
  410. }
  411. // DeleteTd removes all block total difficulty data associated with a hash.
  412. func DeleteTd(db ethdb.KeyValueWriter, hash common.Hash, number uint64) {
  413. if err := db.Delete(headerTDKey(number, hash)); err != nil {
  414. log.Crit("Failed to delete block total difficulty", "err", err)
  415. }
  416. }
  417. // HasReceipts verifies the existence of all the transaction receipts belonging
  418. // to a block.
  419. func HasReceipts(db ethdb.Reader, hash common.Hash, number uint64) bool {
  420. if has, err := db.Ancient(freezerHashTable, number); err == nil && common.BytesToHash(has) == hash {
  421. return true
  422. }
  423. if has, err := db.Has(blockReceiptsKey(number, hash)); !has || err != nil {
  424. return false
  425. }
  426. return true
  427. }
  428. // ReadReceiptsRLP retrieves all the transaction receipts belonging to a block in RLP encoding.
  429. func ReadReceiptsRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue {
  430. // First try to look up the data in ancient database. Extra hash
  431. // comparison is necessary since ancient database only maintains
  432. // the canonical data.
  433. data, _ := db.Ancient(freezerReceiptTable, number)
  434. if len(data) > 0 {
  435. h, _ := db.Ancient(freezerHashTable, number)
  436. if common.BytesToHash(h) == hash {
  437. return data
  438. }
  439. }
  440. // Then try to look up the data in leveldb.
  441. data, _ = db.Get(blockReceiptsKey(number, hash))
  442. if len(data) > 0 {
  443. return data
  444. }
  445. // In the background freezer is moving data from leveldb to flatten files.
  446. // So during the first check for ancient db, the data is not yet in there,
  447. // but when we reach into leveldb, the data was already moved. That would
  448. // result in a not found error.
  449. data, _ = db.Ancient(freezerReceiptTable, number)
  450. if len(data) > 0 {
  451. h, _ := db.Ancient(freezerHashTable, number)
  452. if common.BytesToHash(h) == hash {
  453. return data
  454. }
  455. }
  456. return nil // Can't find the data anywhere.
  457. }
  458. // ReadRawReceipts retrieves all the transaction receipts belonging to a block.
  459. // The receipt metadata fields are not guaranteed to be populated, so they
  460. // should not be used. Use ReadReceipts instead if the metadata is needed.
  461. func ReadRawReceipts(db ethdb.Reader, hash common.Hash, number uint64) types.Receipts {
  462. // Retrieve the flattened receipt slice
  463. data := ReadReceiptsRLP(db, hash, number)
  464. if len(data) == 0 {
  465. return nil
  466. }
  467. // Convert the receipts from their storage form to their internal representation
  468. storageReceipts := []*types.ReceiptForStorage{}
  469. if err := rlp.DecodeBytes(data, &storageReceipts); err != nil {
  470. log.Error("Invalid receipt array RLP", "hash", hash, "err", err)
  471. return nil
  472. }
  473. receipts := make(types.Receipts, len(storageReceipts))
  474. for i, storageReceipt := range storageReceipts {
  475. receipts[i] = (*types.Receipt)(storageReceipt)
  476. }
  477. return receipts
  478. }
  479. // ReadReceipts retrieves all the transaction receipts belonging to a block, including
  480. // its correspoinding metadata fields. If it is unable to populate these metadata
  481. // fields then nil is returned.
  482. //
  483. // The current implementation populates these metadata fields by reading the receipts'
  484. // corresponding block body, so if the block body is not found it will return nil even
  485. // if the receipt itself is stored.
  486. func ReadReceipts(db ethdb.Reader, hash common.Hash, number uint64, config *params.ChainConfig) types.Receipts {
  487. // We're deriving many fields from the block body, retrieve beside the receipt
  488. receipts := ReadRawReceipts(db, hash, number)
  489. if receipts == nil {
  490. return nil
  491. }
  492. body := ReadBody(db, hash, number)
  493. if body == nil {
  494. log.Error("Missing body but have receipt", "hash", hash, "number", number)
  495. return nil
  496. }
  497. if err := receipts.DeriveFields(config, hash, number, body.Transactions); err != nil {
  498. log.Error("Failed to derive block receipts fields", "hash", hash, "number", number, "err", err)
  499. return nil
  500. }
  501. return receipts
  502. }
  503. // WriteReceipts stores all the transaction receipts belonging to a block.
  504. func WriteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64, receipts types.Receipts) {
  505. // Convert the receipts into their storage form and serialize them
  506. storageReceipts := make([]*types.ReceiptForStorage, len(receipts))
  507. for i, receipt := range receipts {
  508. storageReceipts[i] = (*types.ReceiptForStorage)(receipt)
  509. }
  510. bytes, err := rlp.EncodeToBytes(storageReceipts)
  511. if err != nil {
  512. log.Crit("Failed to encode block receipts", "err", err)
  513. }
  514. // Store the flattened receipt slice
  515. if err := db.Put(blockReceiptsKey(number, hash), bytes); err != nil {
  516. log.Crit("Failed to store block receipts", "err", err)
  517. }
  518. }
  519. // DeleteReceipts removes all receipt data associated with a block hash.
  520. func DeleteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64) {
  521. if err := db.Delete(blockReceiptsKey(number, hash)); err != nil {
  522. log.Crit("Failed to delete block receipts", "err", err)
  523. }
  524. }
  525. // ReadBlock retrieves an entire block corresponding to the hash, assembling it
  526. // back from the stored header and body. If either the header or body could not
  527. // be retrieved nil is returned.
  528. //
  529. // Note, due to concurrent download of header and block body the header and thus
  530. // canonical hash can be stored in the database but the body data not (yet).
  531. func ReadBlock(db ethdb.Reader, hash common.Hash, number uint64) *types.Block {
  532. header := ReadHeader(db, hash, number)
  533. if header == nil {
  534. return nil
  535. }
  536. body := ReadBody(db, hash, number)
  537. if body == nil {
  538. return nil
  539. }
  540. return types.NewBlockWithHeader(header).WithBody(body.Transactions, body.Uncles)
  541. }
  542. // WriteBlock serializes a block into the database, header and body separately.
  543. func WriteBlock(db ethdb.KeyValueWriter, block *types.Block) {
  544. WriteBody(db, block.Hash(), block.NumberU64(), block.Body())
  545. WriteHeader(db, block.Header())
  546. }
  547. // WriteAncientBlock writes entire block data into ancient store and returns the total written size.
  548. func WriteAncientBlock(db ethdb.AncientWriter, block *types.Block, receipts types.Receipts, td *big.Int) int {
  549. // Encode all block components to RLP format.
  550. headerBlob, err := rlp.EncodeToBytes(block.Header())
  551. if err != nil {
  552. log.Crit("Failed to RLP encode block header", "err", err)
  553. }
  554. bodyBlob, err := rlp.EncodeToBytes(block.Body())
  555. if err != nil {
  556. log.Crit("Failed to RLP encode body", "err", err)
  557. }
  558. storageReceipts := make([]*types.ReceiptForStorage, len(receipts))
  559. for i, receipt := range receipts {
  560. storageReceipts[i] = (*types.ReceiptForStorage)(receipt)
  561. }
  562. receiptBlob, err := rlp.EncodeToBytes(storageReceipts)
  563. if err != nil {
  564. log.Crit("Failed to RLP encode block receipts", "err", err)
  565. }
  566. tdBlob, err := rlp.EncodeToBytes(td)
  567. if err != nil {
  568. log.Crit("Failed to RLP encode block total difficulty", "err", err)
  569. }
  570. // Write all blob to flatten files.
  571. err = db.AppendAncient(block.NumberU64(), block.Hash().Bytes(), headerBlob, bodyBlob, receiptBlob, tdBlob)
  572. if err != nil {
  573. log.Crit("Failed to write block data to ancient store", "err", err)
  574. }
  575. return len(headerBlob) + len(bodyBlob) + len(receiptBlob) + len(tdBlob) + common.HashLength
  576. }
  577. // DeleteBlock removes all block data associated with a hash.
  578. func DeleteBlock(db ethdb.KeyValueWriter, hash common.Hash, number uint64) {
  579. DeleteReceipts(db, hash, number)
  580. DeleteHeader(db, hash, number)
  581. DeleteBody(db, hash, number)
  582. DeleteTd(db, hash, number)
  583. }
  584. // DeleteBlockWithoutNumber removes all block data associated with a hash, except
  585. // the hash to number mapping.
  586. func DeleteBlockWithoutNumber(db ethdb.KeyValueWriter, hash common.Hash, number uint64) {
  587. DeleteReceipts(db, hash, number)
  588. deleteHeaderWithoutNumber(db, hash, number)
  589. DeleteBody(db, hash, number)
  590. DeleteTd(db, hash, number)
  591. }
  592. // FindCommonAncestor returns the last common ancestor of two block headers
  593. func FindCommonAncestor(db ethdb.Reader, a, b *types.Header) *types.Header {
  594. for bn := b.Number.Uint64(); a.Number.Uint64() > bn; {
  595. a = ReadHeader(db, a.ParentHash, a.Number.Uint64()-1)
  596. if a == nil {
  597. return nil
  598. }
  599. }
  600. for an := a.Number.Uint64(); an < b.Number.Uint64(); {
  601. b = ReadHeader(db, b.ParentHash, b.Number.Uint64()-1)
  602. if b == nil {
  603. return nil
  604. }
  605. }
  606. for a.Hash() != b.Hash() {
  607. a = ReadHeader(db, a.ParentHash, a.Number.Uint64()-1)
  608. if a == nil {
  609. return nil
  610. }
  611. b = ReadHeader(db, b.ParentHash, b.Number.Uint64()-1)
  612. if b == nil {
  613. return nil
  614. }
  615. }
  616. return a
  617. }