Documentation
¶
Overview ¶
Package rawdb contains a collection of low level database accessors.
Index ¶
- Variables
- func DeleteBlock(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteBlockWithoutNumber(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteBody(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteCanonicalHash(db ethdb.KeyValueWriter, number uint64)
- func DeleteHeader(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteHeaderNumber(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteTd(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteTxLookupEntry(db ethdb.KeyValueWriter, hash common.Hash)
- func FindCommonAncestor(db ethdb.Reader, a, b *types.Header) *types.Header
- func HasBody(db ethdb.Reader, hash common.Hash, number uint64) bool
- func HasHeader(db ethdb.Reader, hash common.Hash, number uint64) bool
- func HasReceipts(db ethdb.Reader, hash common.Hash, number uint64) bool
- func InitDatabaseFromFreezer(db ethdb.Database) error
- func InspectDatabase(db ethdb.Database) error
- func NewDatabase(db ethdb.KeyValueStore) ethdb.Database
- func NewDatabaseWithFreezer(db ethdb.KeyValueStore, freezer string, namespace string) (ethdb.Database, error)
- func NewLevelDBDatabase(file string, cache int, handles int, namespace string) (ethdb.Database, error)
- func NewLevelDBDatabaseWithFreezer(file string, cache int, handles int, freezer string, namespace string) (ethdb.Database, error)
- func NewMemoryDatabase() ethdb.Database
- func NewMemoryDatabaseWithCap(size int) ethdb.Database
- func NewTable(db ethdb.Database, prefix string) ethdb.Database
- func ReadAllHashes(db ethdb.Iteratee, number uint64) []common.Hash
- func ReadBlock(db ethdb.Reader, hash common.Hash, number uint64) *types.Block
- func ReadBloomBits(db ethdb.KeyValueReader, bit uint, section uint64, head common.Hash) ([]byte, error)
- func ReadBody(db ethdb.Reader, hash common.Hash, number uint64) *types.Body
- func ReadBodyRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue
- func ReadCanonicalHash(db ethdb.Reader, number uint64) common.Hash
- func ReadChainConfig(db ethdb.KeyValueReader, hash common.Hash) *params.ChainConfig
- func ReadDatabaseVersion(db ethdb.KeyValueReader) *uint64
- func ReadFastTrieProgress(db ethdb.KeyValueReader) uint64
- func ReadHeadBlockHash(db ethdb.KeyValueReader) common.Hash
- func ReadHeadFastBlockHash(db ethdb.KeyValueReader) common.Hash
- func ReadHeadHeaderHash(db ethdb.KeyValueReader) common.Hash
- func ReadHeader(db ethdb.Reader, hash common.Hash, number uint64) *types.Header
- func ReadHeaderNumber(db ethdb.KeyValueReader, hash common.Hash) *uint64
- func ReadHeaderRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue
- func ReadPreimage(db ethdb.KeyValueReader, hash common.Hash) []byte
- func ReadRawReceipts(db ethdb.Reader, hash common.Hash, number uint64) types.Receipts
- func ReadReceipt(db ethdb.Reader, hash common.Hash, config *params.ChainConfig) (*types.Receipt, common.Hash, uint64, uint64)
- func ReadReceipts(db ethdb.Reader, hash common.Hash, number uint64, config *params.ChainConfig) types.Receipts
- func ReadReceiptsRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue
- func ReadTd(db ethdb.Reader, hash common.Hash, number uint64) *big.Int
- func ReadTdRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue
- func ReadTransaction(db ethdb.Reader, hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)
- func ReadTxLookupEntry(db ethdb.Reader, hash common.Hash) *uint64
- func WriteAncientBlock(db ethdb.AncientWriter, block *types.Block, receipts types.Receipts, ...) int
- func WriteBlock(db ethdb.KeyValueWriter, block *types.Block)
- func WriteBloomBits(db ethdb.KeyValueWriter, bit uint, section uint64, head common.Hash, ...)
- func WriteBody(db ethdb.KeyValueWriter, hash common.Hash, number uint64, body *types.Body)
- func WriteBodyRLP(db ethdb.KeyValueWriter, hash common.Hash, number uint64, rlp rlp.RawValue)
- func WriteCanonicalHash(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func WriteChainConfig(db ethdb.KeyValueWriter, hash common.Hash, cfg *params.ChainConfig)
- func WriteDatabaseVersion(db ethdb.KeyValueWriter, version uint64)
- func WriteFastTrieProgress(db ethdb.KeyValueWriter, count uint64)
- func WriteHeadBlockHash(db ethdb.KeyValueWriter, hash common.Hash)
- func WriteHeadFastBlockHash(db ethdb.KeyValueWriter, hash common.Hash)
- func WriteHeadHeaderHash(db ethdb.KeyValueWriter, hash common.Hash)
- func WriteHeader(db ethdb.KeyValueWriter, header *types.Header)
- func WriteHeaderNumber(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func WritePreimages(db ethdb.KeyValueWriter, preimages map[common.Hash][]byte)
- func WriteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64, ...)
- func WriteTd(db ethdb.KeyValueWriter, hash common.Hash, number uint64, td *big.Int)
- func WriteTxLookupEntries(db ethdb.KeyValueWriter, block *types.Block)
- type LegacyTxLookupEntry
Constants ¶
This section is empty.
Variables ¶
var ( // Chain index prefixes (use `i` + single byte to avoid mixing data types). BloomBitsIndexPrefix = []byte("iB") // BloomBitsIndexPrefix is the data table of a chain indexer to track its progress )
The fields below define the low level database schema prefixing.
Functions ¶
func DeleteBlock ¶
func DeleteBlock(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteBlock removes all block data associated with a hash.
func DeleteBlockWithoutNumber ¶ added in v0.1.6
func DeleteBlockWithoutNumber(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteBlockWithoutNumber removes all block data associated with a hash, except the hash to number mapping.
func DeleteBody ¶
func DeleteBody(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteBody removes all block body data associated with a hash.
func DeleteCanonicalHash ¶
func DeleteCanonicalHash(db ethdb.KeyValueWriter, number uint64)
DeleteCanonicalHash removes the number to hash canonical mapping.
func DeleteHeader ¶
func DeleteHeader(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteHeader removes all block header data associated with a hash.
func DeleteHeaderNumber ¶ added in v0.1.6
func DeleteHeaderNumber(db ethdb.KeyValueWriter, hash common.Hash)
DeleteHeaderNumber removes hash->number mapping.
func DeleteReceipts ¶
func DeleteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteReceipts removes all receipt data associated with a block hash.
func DeleteTd ¶
func DeleteTd(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteTd removes all block total difficulty data associated with a hash.
func DeleteTxLookupEntry ¶
func DeleteTxLookupEntry(db ethdb.KeyValueWriter, hash common.Hash)
DeleteTxLookupEntry removes all transaction data associated with a hash.
func FindCommonAncestor ¶
FindCommonAncestor returns the last common ancestor of two block headers
func HasReceipts ¶
HasReceipts verifies the existence of all the transaction receipts belonging to a block.
func InitDatabaseFromFreezer ¶ added in v0.1.6
InitDatabaseFromFreezer reinitializes an empty database from a previous batch of frozen ancient blocks. The method iterates over all the frozen blocks and injects into the database the block hash->number mappings and the transaction lookup entries.
func InspectDatabase ¶ added in v0.1.6
InspectDatabase traverses the entire database and checks the size of all different categories of data.
func NewDatabase ¶ added in v0.1.6
func NewDatabase(db ethdb.KeyValueStore) ethdb.Database
NewDatabase creates a high level database on top of a given key-value data store without a freezer moving immutable chain segments into cold storage.
func NewDatabaseWithFreezer ¶ added in v0.1.6
func NewDatabaseWithFreezer(db ethdb.KeyValueStore, freezer string, namespace string) (ethdb.Database, error)
NewDatabaseWithFreezer creates a high level database on top of a given key- value data store with a freezer moving immutable chain segments into cold storage.
func NewLevelDBDatabase ¶ added in v0.1.6
func NewLevelDBDatabase(file string, cache int, handles int, namespace string) (ethdb.Database, error)
NewLevelDBDatabase creates a persistent key-value database without a freezer moving immutable chain segments into cold storage.
func NewLevelDBDatabaseWithFreezer ¶ added in v0.1.6
func NewLevelDBDatabaseWithFreezer(file string, cache int, handles int, freezer string, namespace string) (ethdb.Database, error)
NewLevelDBDatabaseWithFreezer creates a persistent key-value database with a freezer moving immutable chain segments into cold storage.
func NewMemoryDatabase ¶ added in v0.1.6
NewMemoryDatabase creates an ephemeral in-memory key-value database without a freezer moving immutable chain segments into cold storage.
func NewMemoryDatabaseWithCap ¶ added in v0.1.6
NewMemoryDatabaseWithCap creates an ephemeral in-memory key-value database with an initial starting capacity, but without a freezer moving immutable chain segments into cold storage.
func NewTable ¶ added in v0.1.6
NewTable returns a database object that prefixes all keys with a given string.
func ReadAllHashes ¶ added in v0.1.6
ReadAllHashes retrieves all the hashes assigned to blocks at a certain heights, both canonical and reorged forks included.
func ReadBlock ¶
ReadBlock retrieves an entire block corresponding to the hash, assembling it back from the stored header and body. If either the header or body could not be retrieved nil is returned.
Note, due to concurrent download of header and block body the header and thus canonical hash can be stored in the database but the body data not (yet).
func ReadBloomBits ¶
func ReadBloomBits(db ethdb.KeyValueReader, bit uint, section uint64, head common.Hash) ([]byte, error)
ReadBloomBits retrieves the compressed bloom bit vector belonging to the given section and bit index from the.
func ReadBodyRLP ¶
ReadBodyRLP retrieves the block body (transactions and uncles) in RLP encoding.
func ReadCanonicalHash ¶
ReadCanonicalHash retrieves the hash assigned to a canonical block number.
func ReadChainConfig ¶
func ReadChainConfig(db ethdb.KeyValueReader, hash common.Hash) *params.ChainConfig
ReadChainConfig retrieves the consensus settings based on the given genesis hash.
func ReadDatabaseVersion ¶
func ReadDatabaseVersion(db ethdb.KeyValueReader) *uint64
ReadDatabaseVersion retrieves the version number of the database.
func ReadFastTrieProgress ¶
func ReadFastTrieProgress(db ethdb.KeyValueReader) uint64
ReadFastTrieProgress retrieves the number of tries nodes fast synced to allow reporting correct numbers across restarts.
func ReadHeadBlockHash ¶
func ReadHeadBlockHash(db ethdb.KeyValueReader) common.Hash
ReadHeadBlockHash retrieves the hash of the current canonical head block.
func ReadHeadFastBlockHash ¶
func ReadHeadFastBlockHash(db ethdb.KeyValueReader) common.Hash
ReadHeadFastBlockHash retrieves the hash of the current fast-sync head block.
func ReadHeadHeaderHash ¶
func ReadHeadHeaderHash(db ethdb.KeyValueReader) common.Hash
ReadHeadHeaderHash retrieves the hash of the current canonical head header.
func ReadHeader ¶
ReadHeader retrieves the block header corresponding to the hash.
func ReadHeaderNumber ¶
func ReadHeaderNumber(db ethdb.KeyValueReader, hash common.Hash) *uint64
ReadHeaderNumber returns the header number assigned to a hash.
func ReadHeaderRLP ¶
ReadHeaderRLP retrieves a block header in its raw RLP database encoding.
func ReadPreimage ¶
func ReadPreimage(db ethdb.KeyValueReader, hash common.Hash) []byte
ReadPreimage retrieves a single preimage of the provided hash.
func ReadRawReceipts ¶ added in v0.1.6
ReadRawReceipts retrieves all the transaction receipts belonging to a block. The receipt metadata fields are not guaranteed to be populated, so they should not be used. Use ReadReceipts instead if the metadata is needed.
func ReadReceipt ¶
func ReadReceipt(db ethdb.Reader, hash common.Hash, config *params.ChainConfig) (*types.Receipt, common.Hash, uint64, uint64)
ReadReceipt retrieves a specific transaction receipt from the database, along with its added positional metadata.
func ReadReceipts ¶
func ReadReceipts(db ethdb.Reader, hash common.Hash, number uint64, config *params.ChainConfig) types.Receipts
ReadReceipts retrieves all the transaction receipts belonging to a block, including its correspoinding metadata fields. If it is unable to populate these metadata fields then nil is returned.
The current implementation populates these metadata fields by reading the receipts' corresponding block body, so if the block body is not found it will return nil even if the receipt itself is stored.
func ReadReceiptsRLP ¶ added in v0.1.6
ReadReceiptsRLP retrieves all the transaction receipts belonging to a block in RLP encoding.
func ReadTdRLP ¶ added in v0.1.6
ReadTdRLP retrieves a block's total difficulty corresponding to the hash in RLP encoding.
func ReadTransaction ¶
func ReadTransaction(db ethdb.Reader, hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)
ReadTransaction retrieves a specific transaction from the database, along with its added positional metadata.
func ReadTxLookupEntry ¶
ReadTxLookupEntry retrieves the positional metadata associated with a transaction hash to allow retrieving the transaction or receipt by hash.
func WriteAncientBlock ¶ added in v0.1.6
func WriteAncientBlock(db ethdb.AncientWriter, block *types.Block, receipts types.Receipts, td *big.Int) int
WriteAncientBlock writes entire block data into ancient store and returns the total written size.
func WriteBlock ¶
func WriteBlock(db ethdb.KeyValueWriter, block *types.Block)
WriteBlock serializes a block into the database, header and body separately.
func WriteBloomBits ¶
func WriteBloomBits(db ethdb.KeyValueWriter, bit uint, section uint64, head common.Hash, bits []byte)
WriteBloomBits stores the compressed bloom bits vector belonging to the given section and bit index.
func WriteBodyRLP ¶
WriteBodyRLP stores an RLP encoded block body into the database.
func WriteCanonicalHash ¶
func WriteCanonicalHash(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
WriteCanonicalHash stores the hash assigned to a canonical block number.
func WriteChainConfig ¶
func WriteChainConfig(db ethdb.KeyValueWriter, hash common.Hash, cfg *params.ChainConfig)
WriteChainConfig writes the chain config settings to the database.
func WriteDatabaseVersion ¶
func WriteDatabaseVersion(db ethdb.KeyValueWriter, version uint64)
WriteDatabaseVersion stores the version number of the database
func WriteFastTrieProgress ¶
func WriteFastTrieProgress(db ethdb.KeyValueWriter, count uint64)
WriteFastTrieProgress stores the fast sync trie process counter to support retrieving it across restarts.
func WriteHeadBlockHash ¶
func WriteHeadBlockHash(db ethdb.KeyValueWriter, hash common.Hash)
WriteHeadBlockHash stores the head block's hash.
func WriteHeadFastBlockHash ¶
func WriteHeadFastBlockHash(db ethdb.KeyValueWriter, hash common.Hash)
WriteHeadFastBlockHash stores the hash of the current fast-sync head block.
func WriteHeadHeaderHash ¶
func WriteHeadHeaderHash(db ethdb.KeyValueWriter, hash common.Hash)
WriteHeadHeaderHash stores the hash of the current canonical head header.
func WriteHeader ¶
func WriteHeader(db ethdb.KeyValueWriter, header *types.Header)
WriteHeader stores a block header into the database and also stores the hash- to-number mapping.
func WriteHeaderNumber ¶ added in v0.1.6
func WriteHeaderNumber(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
WriteHeaderNumber stores the hash->number mapping.
func WritePreimages ¶
func WritePreimages(db ethdb.KeyValueWriter, preimages map[common.Hash][]byte)
WritePreimages writes the provided set of preimages to the database.
func WriteReceipts ¶
func WriteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64, receipts types.Receipts)
WriteReceipts stores all the transaction receipts belonging to a block.
func WriteTxLookupEntries ¶
func WriteTxLookupEntries(db ethdb.KeyValueWriter, block *types.Block)
WriteTxLookupEntries stores a positional metadata for every transaction from a block, enabling hash based transaction and receipt lookups.