Documentation ¶
Overview ¶
Package rawdb contains a collection of low level database accessors.
Index ¶
- Variables
- func AddCodeToFetch(db ethdb.KeyValueWriter, hash common.Hash)
- func ClearAllSyncSegments(db ethdb.KeyValueStore) error
- func ClearAllSyncStorageTries(db ethdb.KeyValueStore) error
- func ClearPrefix(db ethdb.KeyValueStore, prefix []byte) error
- func ClearSyncSegments(db ethdb.KeyValueStore, root common.Hash) error
- func ClearSyncStorageTrie(db ethdb.KeyValueStore, root common.Hash) error
- func DeleteAccountSnapshot(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteBlock(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteBlockWithoutNumber(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteBloombits(db ethdb.Database, bit uint, from uint64, to uint64)
- func DeleteBody(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteCanonicalHash(db ethdb.KeyValueWriter, number uint64)
- func DeleteCode(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteCodeToFetch(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteHeader(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteHeaderNumber(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteOfflinePruning(db ethdb.KeyValueStore) error
- func DeletePopulateMissingTries(db ethdb.KeyValueStore) error
- func DeletePruningDisabled(db ethdb.KeyValueStore) error
- func DeleteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteSnapshotBlockHash(db ethdb.KeyValueWriter)
- func DeleteSnapshotRoot(db ethdb.KeyValueWriter)
- func DeleteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash)
- func DeleteTimeMarker(db ethdb.KeyValueStore, key []byte) error
- func DeleteTrieNode(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteTxLookupEntries(db ethdb.KeyValueWriter, hashes []common.Hash)
- 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 HasCode(db ethdb.KeyValueReader, hash common.Hash) bool
- func HasCodeWithPrefix(db ethdb.KeyValueReader, hash common.Hash) bool
- func HasHeader(db ethdb.Reader, hash common.Hash, number uint64) bool
- func HasPruningDisabled(db ethdb.KeyValueStore) (bool, error)
- func HasReceipts(db ethdb.Reader, hash common.Hash, number uint64) bool
- func HasTrieNode(db ethdb.KeyValueReader, hash common.Hash) bool
- func InspectDatabase(db ethdb.Database, keyPrefix, keyStart []byte) error
- func IsCodeKey(key []byte) (bool, []byte)
- func IterateAccountSnapshots(db ethdb.Iteratee) ethdb.Iterator
- func IterateStorageSnapshots(db ethdb.Iteratee, accountHash common.Hash) ethdb.Iterator
- func NewDatabase(db ethdb.KeyValueStore) ethdb.Database
- func NewKeyLengthIterator(it ethdb.Iterator, keyLen int) ethdb.Iterator
- func NewLevelDBDatabase(file string, cache int, handles int, namespace string, readonly bool) (ethdb.Database, error)
- func NewMemoryDatabase() ethdb.Database
- func NewMemoryDatabaseWithCap(size int) ethdb.Database
- func NewSyncSegmentsIterator(db ethdb.Iteratee, root common.Hash) ethdb.Iterator
- func NewSyncStorageTriesIterator(db ethdb.Iteratee, seek []byte) ethdb.Iterator
- func NewTable(db ethdb.Database, prefix string) ethdb.Database
- func PopUncleanShutdownMarker(db ethdb.KeyValueStore)
- func PushUncleanShutdownMarker(db ethdb.KeyValueStore) ([]uint64, uint64, error)
- func ReadAcceptorTip(db ethdb.KeyValueReader) (common.Hash, error)
- func ReadAccountSnapshot(db ethdb.KeyValueReader, hash common.Hash) []byte
- func ReadAllCanonicalHashes(db ethdb.Iteratee, from uint64, to uint64, limit int) ([]uint64, []common.Hash)
- 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 ReadCanonicalBodyRLP(db ethdb.Reader, number uint64) rlp.RawValue
- func ReadCanonicalHash(db ethdb.Reader, number uint64) common.Hash
- func ReadChainConfig(db ethdb.KeyValueReader, hash common.Hash) *params.ChainConfig
- func ReadCode(db ethdb.KeyValueReader, hash common.Hash) []byte
- func ReadCodeWithPrefix(db ethdb.KeyValueReader, hash common.Hash) []byte
- func ReadDatabaseVersion(db ethdb.KeyValueReader) *uint64
- func ReadHeadBlock(db ethdb.Reader) *types.Block
- func ReadHeadBlockHash(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 ReadLogs(db ethdb.Reader, hash common.Hash, number uint64) [][]*types.Log
- func ReadOfflinePruning(db ethdb.KeyValueStore) (time.Time, error)
- func ReadPopulateMissingTries(db ethdb.KeyValueStore) (time.Time, error)
- 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 ReadSnapshotBlockHash(db ethdb.KeyValueReader) common.Hash
- func ReadSnapshotGenerator(db ethdb.KeyValueReader) []byte
- func ReadSnapshotRoot(db ethdb.KeyValueReader) common.Hash
- func ReadStorageSnapshot(db ethdb.KeyValueReader, accountHash, storageHash common.Hash) []byte
- func ReadSyncRoot(db ethdb.KeyValueReader) (common.Hash, error)
- func ReadTimeMarker(db ethdb.KeyValueStore, key []byte) (time.Time, error)
- func ReadTransaction(db ethdb.Reader, hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)
- func ReadTrieNode(db ethdb.KeyValueReader, hash common.Hash) []byte
- func ReadTxLookupEntry(db ethdb.Reader, hash common.Hash) *uint64
- func UnpackSyncSegmentKey(keyBytes []byte) (common.Hash, []byte)
- func UnpackSyncStorageTrieKey(keyBytes []byte) (common.Hash, common.Hash)
- func UpdateUncleanShutdownMarker(db ethdb.KeyValueStore)
- func WriteAcceptorTip(db ethdb.KeyValueWriter, hash common.Hash) error
- func WriteAccountSnapshot(db ethdb.KeyValueWriter, hash common.Hash, entry []byte)
- 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 WriteCode(db ethdb.KeyValueWriter, hash common.Hash, code []byte)
- func WriteDatabaseVersion(db ethdb.KeyValueWriter, version uint64)
- func WriteHeadBlockHash(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 WriteOfflinePruning(db ethdb.KeyValueStore) error
- func WritePopulateMissingTries(db ethdb.KeyValueStore) error
- func WritePreimages(db ethdb.KeyValueWriter, preimages map[common.Hash][]byte)
- func WritePruningDisabled(db ethdb.KeyValueStore) error
- func WriteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64, ...)
- func WriteSnapshotBlockHash(db ethdb.KeyValueWriter, blockHash common.Hash)
- func WriteSnapshotGenerator(db ethdb.KeyValueWriter, generator []byte)
- func WriteSnapshotRoot(db ethdb.KeyValueWriter, root common.Hash)
- func WriteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash, entry []byte)
- func WriteSyncRoot(db ethdb.KeyValueWriter, root common.Hash) error
- func WriteSyncSegment(db ethdb.KeyValueWriter, root common.Hash, start []byte) error
- func WriteSyncStorageTrie(db ethdb.KeyValueWriter, root common.Hash, account common.Hash) error
- func WriteTimeMarker(db ethdb.KeyValueStore, key []byte) error
- func WriteTrieNode(db ethdb.KeyValueWriter, hash common.Hash, node []byte)
- func WriteTxLookupEntries(db ethdb.KeyValueWriter, number uint64, hashes []common.Hash)
- func WriteTxLookupEntriesByBlock(db ethdb.KeyValueWriter, block *types.Block)
- type KeyLengthIterator
- type LegacyTxLookupEntry
- type NumberHash
Constants ¶
This section is empty.
Variables ¶
var ( SnapshotAccountPrefix = []byte("a") // SnapshotAccountPrefix + account hash -> account trie value SnapshotStoragePrefix = []byte("o") // SnapshotStoragePrefix + account hash + storage hash -> storage trie value CodePrefix = []byte("c") // CodePrefix + code hash -> account code CodeToFetchPrefix = []byte("CP") // CodeToFetchPrefix + code hash -> empty value tracks the outstanding code hashes we need to fetch. // 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 AddCodeToFetch ¶
func AddCodeToFetch(db ethdb.KeyValueWriter, hash common.Hash)
AddCodeToFetch adds a marker that we need to fetch the code for hash.
func ClearAllSyncSegments ¶ added in v0.8.15
func ClearAllSyncSegments(db ethdb.KeyValueStore) error
ClearAllSyncSegments removes all segment markers from db
func ClearAllSyncStorageTries ¶ added in v0.8.15
func ClearAllSyncStorageTries(db ethdb.KeyValueStore) error
ClearAllSyncStorageTries removes all storage tries added for syncing from db
func ClearPrefix ¶ added in v0.8.15
func ClearPrefix(db ethdb.KeyValueStore, prefix []byte) error
ClearPrefix removes all keys in db that begin with prefix
func ClearSyncSegments ¶ added in v0.8.15
func ClearSyncSegments(db ethdb.KeyValueStore, root common.Hash) error
ClearSegment removes segment markers for root from db
func ClearSyncStorageTrie ¶ added in v0.8.15
func ClearSyncStorageTrie(db ethdb.KeyValueStore, root common.Hash) error
ClearSyncStorageTrie removes all storage trie accounts (with the given root) from db. Intended for use when the trie with root has completed syncing.
func DeleteAccountSnapshot ¶
func DeleteAccountSnapshot(db ethdb.KeyValueWriter, hash common.Hash)
DeleteAccountSnapshot removes the snapshot entry of an account trie leaf.
func DeleteBlock ¶
func DeleteBlock(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteBlock removes all block data associated with a hash.
func DeleteBlockWithoutNumber ¶
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 DeleteBloombits ¶
DeleteBloombits removes all compressed bloom bits vector belonging to the given section range and bit index.
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 DeleteCode ¶
func DeleteCode(db ethdb.KeyValueWriter, hash common.Hash)
DeleteCode deletes the specified contract code from the database.
func DeleteCodeToFetch ¶
func DeleteCodeToFetch(db ethdb.KeyValueWriter, hash common.Hash)
DeleteCodeToFetch removes the marker that the code corresponding to hash needs to be fetched.
func DeleteHeader ¶
func DeleteHeader(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteHeader removes all block header data associated with a hash.
func DeleteHeaderNumber ¶
func DeleteHeaderNumber(db ethdb.KeyValueWriter, hash common.Hash)
DeleteHeaderNumber removes hash->number mapping.
func DeleteOfflinePruning ¶
func DeleteOfflinePruning(db ethdb.KeyValueStore) error
DeleteOfflinePruning deletes any marker of the last attempt to run offline pruning.
func DeletePopulateMissingTries ¶
func DeletePopulateMissingTries(db ethdb.KeyValueStore) error
DeletePopulateMissingTries deletes any marker of the last attempt to re-populate missing trie nodes.
func DeletePruningDisabled ¶
func DeletePruningDisabled(db ethdb.KeyValueStore) error
DeletePruningDisabled deletes the marker indicating that the node has run with pruning disabled.
func DeleteReceipts ¶
func DeleteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteReceipts removes all receipt data associated with a block hash.
func DeleteSnapshotBlockHash ¶
func DeleteSnapshotBlockHash(db ethdb.KeyValueWriter)
DeleteSnapshotBlockHash deletes the hash of the block whose state is contained in the persisted snapshot. Since snapshots are not immutable, this method can be used during updates, so a crash or failure will mark the entire snapshot invalid.
func DeleteSnapshotRoot ¶
func DeleteSnapshotRoot(db ethdb.KeyValueWriter)
DeleteSnapshotRoot deletes the root of the block whose state is contained in the persisted snapshot. Since snapshots are not immutable, this method can be used during updates, so a crash or failure will mark the entire snapshot invalid.
func DeleteStorageSnapshot ¶
func DeleteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash)
DeleteStorageSnapshot removes the snapshot entry of an storage trie leaf.
func DeleteTimeMarker ¶
func DeleteTimeMarker(db ethdb.KeyValueStore, key []byte) error
DeleteTimeMarker deletes any value stored at [key]
func DeleteTrieNode ¶
func DeleteTrieNode(db ethdb.KeyValueWriter, hash common.Hash)
DeleteTrieNode deletes the specified trie node from the database.
func DeleteTxLookupEntries ¶
func DeleteTxLookupEntries(db ethdb.KeyValueWriter, hashes []common.Hash)
DeleteTxLookupEntries removes all transaction lookups for a given block.
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 HasCode ¶
func HasCode(db ethdb.KeyValueReader, hash common.Hash) bool
HasCode checks if the contract code corresponding to the provided code hash is present in the db.
func HasCodeWithPrefix ¶
func HasCodeWithPrefix(db ethdb.KeyValueReader, hash common.Hash) bool
HasCodeWithPrefix checks if the contract code corresponding to the provided code hash is present in the db. This function will only check presence using the prefix-scheme.
func HasPruningDisabled ¶
func HasPruningDisabled(db ethdb.KeyValueStore) (bool, error)
HasPruningDisabled returns true if there is a marker present indicating that the node has run with pruning disabled at some pooint.
func HasReceipts ¶
HasReceipts verifies the existence of all the transaction receipts belonging to a block.
func HasTrieNode ¶
func HasTrieNode(db ethdb.KeyValueReader, hash common.Hash) bool
HasTrieNode checks if the trie node with the provided hash is present in db.
func InspectDatabase ¶
InspectDatabase traverses the entire database and checks the size of all different categories of data.
func IsCodeKey ¶
IsCodeKey reports whether the given byte slice is the key of contract code, if so return the raw code hash as well.
func IterateAccountSnapshots ¶
IterateAccountSnapshots returns an iterator for walking all of the accounts in the snapshot
func IterateStorageSnapshots ¶
IterateStorageSnapshots returns an iterator for walking the entire storage space of a specific account.
func NewDatabase ¶
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 NewKeyLengthIterator ¶
NewKeyLengthIterator returns a wrapped version of the iterator that will only return key-value pairs where keys with a specific key length will be returned.
func NewLevelDBDatabase ¶
func NewLevelDBDatabase(file string, cache int, handles int, namespace string, readonly bool) (ethdb.Database, error)
NewLevelDBDatabase creates a persistent key-value database without a freezer moving immutable chain segments into cold storage.
func NewMemoryDatabase ¶
NewMemoryDatabase creates an ephemeral in-memory key-value database without a freezer moving immutable chain segments into cold storage.
func NewMemoryDatabaseWithCap ¶
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 NewSyncSegmentsIterator ¶ added in v0.8.15
NewSyncSegmentsIterator returns a KeyLength iterator over all trie segments added for root. It is the caller's responsibility to unpack the key and call Release on the returned iterator.
func NewSyncStorageTriesIterator ¶ added in v0.8.15
NewSyncStorageTriesIterator returns a KeyLength iterator over all storage tries added for syncing (beginning at seek). It is the caller's responsibility to unpack the key and call Release on the returned iterator.
func PopUncleanShutdownMarker ¶
func PopUncleanShutdownMarker(db ethdb.KeyValueStore)
PopUncleanShutdownMarker removes the last unclean shutdown marker
func PushUncleanShutdownMarker ¶
func PushUncleanShutdownMarker(db ethdb.KeyValueStore) ([]uint64, uint64, error)
PushUncleanShutdownMarker appends a new unclean shutdown marker and returns the previous data - a list of timestamps - a count of how many old unclean-shutdowns have been discarded
func ReadAcceptorTip ¶
func ReadAcceptorTip(db ethdb.KeyValueReader) (common.Hash, error)
ReadAcceptorTip reads the hash of the last accepted block that was fully processed. If there is no value present (the index is being initialized for the first time), then the empty hash is returned.
func ReadAccountSnapshot ¶
func ReadAccountSnapshot(db ethdb.KeyValueReader, hash common.Hash) []byte
ReadAccountSnapshot retrieves the snapshot entry of an account trie leaf.
func ReadAllCanonicalHashes ¶
func ReadAllCanonicalHashes(db ethdb.Iteratee, from uint64, to uint64, limit int) ([]uint64, []common.Hash)
ReadAllCanonicalHashes retrieves all canonical number and hash mappings at the certain chain range. If the accumulated entries reaches the given threshold, abort the iteration and return the semi-finish result.
func ReadAllHashes ¶
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 ReadCanonicalBodyRLP ¶
ReadCanonicalBodyRLP retrieves the block body (transactions and uncles) for the canonical block at number, 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 ReadCode ¶
func ReadCode(db ethdb.KeyValueReader, hash common.Hash) []byte
ReadCode retrieves the contract code of the provided code hash.
func ReadCodeWithPrefix ¶
func ReadCodeWithPrefix(db ethdb.KeyValueReader, hash common.Hash) []byte
ReadCodeWithPrefix retrieves the contract code of the provided code hash. The main difference between this function and ReadCode is this function will only check the existence with latest scheme(with prefix).
func ReadDatabaseVersion ¶
func ReadDatabaseVersion(db ethdb.KeyValueReader) *uint64
ReadDatabaseVersion retrieves the version number of the database.
func ReadHeadBlock ¶
ReadHeadBlock returns the current canonical head block.
func ReadHeadBlockHash ¶
func ReadHeadBlockHash(db ethdb.KeyValueReader) common.Hash
ReadHeadBlockHash retrieves the hash of the current canonical 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 ReadLogs ¶
ReadLogs retrieves the logs for all transactions in a block. The log fields are populated with metadata. In case the receipts or the block body are not found, a nil is returned.
func ReadOfflinePruning ¶
func ReadOfflinePruning(db ethdb.KeyValueStore) (time.Time, error)
ReadOfflinePruning reads the most recent timestamp of an attempt to run offline pruning if present.
func ReadPopulateMissingTries ¶
func ReadPopulateMissingTries(db ethdb.KeyValueStore) (time.Time, error)
ReadPopulateMissingTries reads the most recent timestamp of an attempt to re-populate missing trie nodes.
func ReadPreimage ¶
func ReadPreimage(db ethdb.KeyValueReader, hash common.Hash) []byte
ReadPreimage retrieves a single preimage of the provided hash.
func ReadRawReceipts ¶
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 corresponding 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 ¶
ReadReceiptsRLP retrieves all the transaction receipts belonging to a block in RLP encoding.
func ReadSnapshotBlockHash ¶
func ReadSnapshotBlockHash(db ethdb.KeyValueReader) common.Hash
ReadSnapshotBlockHash retrieves the hash of the block whose state is contained in the persisted snapshot.
func ReadSnapshotGenerator ¶
func ReadSnapshotGenerator(db ethdb.KeyValueReader) []byte
ReadSnapshotGenerator retrieves the serialized snapshot generator saved at the last shutdown.
func ReadSnapshotRoot ¶
func ReadSnapshotRoot(db ethdb.KeyValueReader) common.Hash
ReadSnapshotRoot retrieves the root of the block whose state is contained in the persisted snapshot.
func ReadStorageSnapshot ¶
func ReadStorageSnapshot(db ethdb.KeyValueReader, accountHash, storageHash common.Hash) []byte
ReadStorageSnapshot retrieves the snapshot entry of an storage trie leaf.
func ReadSyncRoot ¶ added in v0.8.15
func ReadSyncRoot(db ethdb.KeyValueReader) (common.Hash, error)
ReadSyncRoot reads the root corresponding to the main trie of an in-progress sync and returns common.Hash{} if no in-progress sync was found.
func ReadTimeMarker ¶
ReadTimeMarker reads the timestamp stored at [key]
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 ReadTrieNode ¶
func ReadTrieNode(db ethdb.KeyValueReader, hash common.Hash) []byte
ReadTrieNode retrieves the trie node of the provided hash.
func ReadTxLookupEntry ¶
ReadTxLookupEntry retrieves the positional metadata associated with a transaction hash to allow retrieving the transaction or receipt by hash.
func UnpackSyncSegmentKey ¶ added in v0.8.15
UnpackSyncSegmentKey returns the root and start position for a trie segment key returned from NewSyncSegmentsIterator.
func UnpackSyncStorageTrieKey ¶ added in v0.8.15
UnpackSyncStorageTrieKey returns the root and account for a storage trie key returned from NewSyncStorageTriesIterator.
func UpdateUncleanShutdownMarker ¶
func UpdateUncleanShutdownMarker(db ethdb.KeyValueStore)
UpdateUncleanShutdownMarker updates the last marker's timestamp to now.
func WriteAcceptorTip ¶
func WriteAcceptorTip(db ethdb.KeyValueWriter, hash common.Hash) error
WriteAcceptorTip writes hash as the last accepted block that has been fully processed.
func WriteAccountSnapshot ¶
func WriteAccountSnapshot(db ethdb.KeyValueWriter, hash common.Hash, entry []byte)
WriteAccountSnapshot stores the snapshot entry of an account trie leaf.
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 WriteCode ¶
func WriteCode(db ethdb.KeyValueWriter, hash common.Hash, code []byte)
WriteCode writes the provided contract code database.
func WriteDatabaseVersion ¶
func WriteDatabaseVersion(db ethdb.KeyValueWriter, version uint64)
WriteDatabaseVersion stores the version number of the database
func WriteHeadBlockHash ¶
func WriteHeadBlockHash(db ethdb.KeyValueWriter, hash common.Hash)
WriteHeadBlockHash stores the head block's hash.
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 ¶
func WriteHeaderNumber(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
WriteHeaderNumber stores the hash->number mapping.
func WriteOfflinePruning ¶
func WriteOfflinePruning(db ethdb.KeyValueStore) error
WriteOfflinePruning writes a marker of the last attempt to run offline pruning The marker is written when offline pruning completes and is deleted when the node is started successfully with offline pruning disabled. This ensures users must disable offline pruning and start their node successfully between runs of offline pruning.
func WritePopulateMissingTries ¶
func WritePopulateMissingTries(db ethdb.KeyValueStore) error
WritePopulateMissingTries writes a marker for the current attempt to populate missing tries.
func WritePreimages ¶
func WritePreimages(db ethdb.KeyValueWriter, preimages map[common.Hash][]byte)
WritePreimages writes the provided set of preimages to the database.
func WritePruningDisabled ¶
func WritePruningDisabled(db ethdb.KeyValueStore) error
WritePruningDisabled writes a marker to track whether the node has ever run with pruning disabled.
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 WriteSnapshotBlockHash ¶
func WriteSnapshotBlockHash(db ethdb.KeyValueWriter, blockHash common.Hash)
WriteSnapshotRoot stores the root of the block whose state is contained in the persisted snapshot.
func WriteSnapshotGenerator ¶
func WriteSnapshotGenerator(db ethdb.KeyValueWriter, generator []byte)
WriteSnapshotGenerator stores the serialized snapshot generator to save at shutdown.
func WriteSnapshotRoot ¶
func WriteSnapshotRoot(db ethdb.KeyValueWriter, root common.Hash)
WriteSnapshotRoot stores the root of the block whose state is contained in the persisted snapshot.
func WriteStorageSnapshot ¶
func WriteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash, entry []byte)
WriteStorageSnapshot stores the snapshot entry of an storage trie leaf.
func WriteSyncRoot ¶ added in v0.8.15
func WriteSyncRoot(db ethdb.KeyValueWriter, root common.Hash) error
WriteSyncRoot writes root as the root of the main trie of the in-progress sync.
func WriteSyncSegment ¶ added in v0.8.15
WriteSyncSegment adds a trie segment for root at the given start position.
func WriteSyncStorageTrie ¶ added in v0.8.15
WriteSyncStorageTrie adds a storage trie for account (with the given root) to be synced.
func WriteTimeMarker ¶
func WriteTimeMarker(db ethdb.KeyValueStore, key []byte) error
WriteTimeMarker writes a marker of the current time in the db at [key]
func WriteTrieNode ¶
func WriteTrieNode(db ethdb.KeyValueWriter, hash common.Hash, node []byte)
WriteTrieNode writes the provided trie node database.
func WriteTxLookupEntries ¶
func WriteTxLookupEntries(db ethdb.KeyValueWriter, number uint64, hashes []common.Hash)
WriteTxLookupEntries is identical to WriteTxLookupEntry, but it works on a list of hashes
func WriteTxLookupEntriesByBlock ¶
func WriteTxLookupEntriesByBlock(db ethdb.KeyValueWriter, block *types.Block)
WriteTxLookupEntriesByBlock stores a positional metadata for every transaction from a block, enabling hash based transaction and receipt lookups.
Types ¶
type KeyLengthIterator ¶
KeyLengthIterator is a wrapper for a database iterator that ensures only key-value pairs with a specific key length will be returned.
func (*KeyLengthIterator) Next ¶
func (it *KeyLengthIterator) Next() bool
type LegacyTxLookupEntry ¶
LegacyTxLookupEntry is the legacy TxLookupEntry definition with some unnecessary fields.
type NumberHash ¶
func ReadAllHashesInRange ¶
func ReadAllHashesInRange(db ethdb.Iteratee, first, last uint64) []*NumberHash
ReadAllHashesInRange retrieves all the hashes assigned to blocks at a certain heights, both canonical and reorged forks included. This method considers both limits to be _inclusive_.