Documentation
¶
Overview ¶
Package rawdb contains a collection of low level database accessors.
Index ¶
- Constants
- 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, keyLen int) 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 DeleteAccountTrieNode(db ethdb.KeyValueWriter, path []byte)
- 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 DeleteLegacyTrieNode(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 DeleteStateID(db ethdb.KeyValueWriter, root common.Hash)
- func DeleteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash)
- func DeleteStorageTrieNode(db ethdb.KeyValueWriter, accountHash common.Hash, path []byte)
- func DeleteTimeMarker(db ethdb.KeyValueStore, key []byte) error
- func DeleteTrieJournal(db ethdb.KeyValueWriter)
- func DeleteTrieNode(db ethdb.KeyValueWriter, owner common.Hash, path []byte, hash common.Hash, ...)
- func DeleteTxLookupEntries(db ethdb.KeyValueWriter, hashes []common.Hash)
- func DeleteTxLookupEntry(db ethdb.KeyValueWriter, hash common.Hash)
- func ExistsAccountTrieNode(db ethdb.KeyValueReader, path []byte) bool
- func ExistsStorageTrieNode(db ethdb.KeyValueReader, accountHash common.Hash, path []byte) bool
- func FindCommonAncestor(db ethdb.Reader, a, b *types.Header) *types.Header
- func GetLatestSyncPerformed(db ethdb.Iteratee) uint64
- func HasAccountTrieNode(db ethdb.KeyValueReader, path []byte, hash common.Hash) bool
- func HasBody(db ethdb.Reader, hash common.Hash, number uint64) bool
- func HasCode(db ethdb.KeyValueReader, hash common.Hash) bool
- func HasHeader(db ethdb.Reader, hash common.Hash, number uint64) bool
- func HasLegacyTrieNode(db ethdb.KeyValueReader, hash common.Hash) bool
- func HasPruningDisabled(db ethdb.KeyValueStore) (bool, error)
- func HasReceipts(db ethdb.Reader, hash common.Hash, number uint64) bool
- func HasStorageTrieNode(db ethdb.KeyValueReader, accountHash common.Hash, path []byte, ...) bool
- func HasTrieNode(db ethdb.KeyValueReader, owner common.Hash, path []byte, hash common.Hash, ...) bool
- func InspectDatabase(db ethdb.Database, keyPrefix, keyStart []byte) error
- func IsAccountTrieNode(key []byte) bool
- func IsCodeKey(key []byte) (bool, []byte)
- func IsLegacyTrieNode(key []byte, val []byte) bool
- func IsStorageTrieNode(key []byte) bool
- func IterateAccountSnapshots(db ethdb.Iteratee) ethdb.Iterator
- func IterateStorageSnapshots(db ethdb.Iteratee, accountHash common.Hash) ethdb.Iterator
- func NewCodeToFetchIterator(db ethdb.Iteratee) 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 NewPebbleDBDatabase(file string, cache int, handles int, namespace string, ...) (ethdb.Database, error)
- func NewSyncPerformedIterator(db ethdb.Iteratee) ethdb.Iterator
- 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 Open(o OpenOptions) (ethdb.Database, error)
- func ParseStateScheme(provided string, disk ethdb.Database) (string, error)
- func PopUncleanShutdownMarker(db ethdb.KeyValueStore)
- func PreexistingDatabase(path string) string
- 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 ReadAccountTrieNode(db ethdb.KeyValueReader, path []byte) ([]byte, common.Hash)
- 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 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 ReadLegacyTrieNode(db ethdb.KeyValueReader, hash common.Hash) []byte
- func ReadLogs(db ethdb.Reader, hash common.Hash, number uint64) [][]*types.Log
- func ReadOfflinePruning(db ethdb.KeyValueStore) (time.Time, error)
- func ReadPersistentStateID(db ethdb.KeyValueReader) uint64
- 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, time uint64, ...) 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 ReadStateID(db ethdb.KeyValueReader, root common.Hash) *uint64
- func ReadStateScheme(db ethdb.Reader) string
- func ReadStorageSnapshot(db ethdb.KeyValueReader, accountHash, storageHash common.Hash) []byte
- func ReadStorageTrieNode(db ethdb.KeyValueReader, accountHash common.Hash, path []byte) ([]byte, common.Hash)
- 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 ReadTrieJournal(db ethdb.KeyValueReader) []byte
- func ReadTrieNode(db ethdb.KeyValueReader, owner common.Hash, path []byte, hash common.Hash, ...) []byte
- func ReadTxIndexTail(db ethdb.KeyValueReader) *uint64
- func ReadTxLookupEntry(db ethdb.Reader, hash common.Hash) *uint64
- func ResolveAccountTrieNodeKey(key []byte) (bool, []byte)
- func ResolveStorageTrieNode(key []byte) (bool, common.Hash, []byte)
- func UnindexTransactions(db ethdb.Database, from uint64, to uint64, interrupt chan struct{})
- func UnpackSyncPerformedKey(key []byte) 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 WriteAccountTrieNode(db ethdb.KeyValueWriter, path []byte, node []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 WriteLegacyTrieNode(db ethdb.KeyValueWriter, hash common.Hash, node []byte)
- func WriteOfflinePruning(db ethdb.KeyValueStore) error
- func WritePersistentStateID(db ethdb.KeyValueWriter, number uint64)
- 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 WriteStateID(db ethdb.KeyValueWriter, root common.Hash, id uint64)
- func WriteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash, entry []byte)
- func WriteStorageTrieNode(db ethdb.KeyValueWriter, accountHash common.Hash, path []byte, node []byte)
- func WriteSyncPerformed(db ethdb.KeyValueWriter, blockNumber uint64) error
- 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 WriteTrieJournal(db ethdb.KeyValueWriter, journal []byte)
- func WriteTrieNode(db ethdb.KeyValueWriter, owner common.Hash, path []byte, hash common.Hash, ...)
- func WriteTxIndexTail(db ethdb.KeyValueWriter, number uint64)
- func WriteTxLookupEntries(db ethdb.KeyValueWriter, number uint64, hashes []common.Hash)
- func WriteTxLookupEntriesByBlock(db ethdb.KeyValueWriter, block *types.Block)
- type KeyLengthIterator
- type LegacyTxLookupEntry
- type NumberHash
- type OpenOptions
Constants ¶
const HashScheme = "hash"
HashScheme is the legacy hash-based state scheme with which trie nodes are stored in the disk with node hash as the database key. The advantage of this scheme is that different versions of trie nodes can be stored in disk, which is very beneficial for constructing archive nodes. The drawback is it will store different trie nodes on the same path to different locations on the disk with no data locality, and it's unfriendly for designing state pruning.
Now this scheme is still kept for backward compatibility, and it will be used for archive node and some other tries(e.g. light trie).
const PathScheme = "path"
PathScheme is the new path-based state scheme with which trie nodes are stored in the disk with node path as the database key. This scheme will only store one version of state data in the disk, which means that the state pruning operation is native. At the same time, this scheme will put adjacent trie nodes in the same area of the disk with good data locality property. But this scheme needs to rely on extra state diffs to survive deep reorg.
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 PreimagePrefix = []byte("secure-key-") // PreimagePrefix + hash -> preimage // BloomBitsIndexPrefix is the data table of a chain indexer to track its progress BloomBitsIndexPrefix = []byte("iB") CodeToFetchPrefix = []byte("CP") // CodeToFetchPrefix + code hash -> empty value tracks the outstanding code hashes we need to fetch. )
The fields below define the low level database schema prefixing.
Functions ¶
func AddCodeToFetch ¶ added in v0.3.0
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.3.0
func ClearAllSyncSegments(db ethdb.KeyValueStore) error
ClearAllSyncSegments removes all segment markers from db
func ClearAllSyncStorageTries ¶ added in v0.3.0
func ClearAllSyncStorageTries(db ethdb.KeyValueStore) error
ClearAllSyncStorageTries removes all storage tries added for syncing from db
func ClearPrefix ¶ added in v0.3.0
func ClearPrefix(db ethdb.KeyValueStore, prefix []byte, keyLen int) error
ClearPrefix removes all keys in db that begin with prefix and match an expected key length. [keyLen] should include the length of the prefix.
func ClearSyncSegments ¶ added in v0.3.0
func ClearSyncSegments(db ethdb.KeyValueStore, root common.Hash) error
ClearSegment removes segment markers for root from db
func ClearSyncStorageTrie ¶ added in v0.3.0
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 DeleteAccountTrieNode ¶ added in v0.5.3
func DeleteAccountTrieNode(db ethdb.KeyValueWriter, path []byte)
DeleteAccountTrieNode deletes the specified account trie node from the database.
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 ¶ added in v0.3.0
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 DeleteLegacyTrieNode ¶ added in v0.5.3
func DeleteLegacyTrieNode(db ethdb.KeyValueWriter, hash common.Hash)
DeleteLegacyTrieNode deletes the specified legacy trie node from database.
func DeleteOfflinePruning ¶ added in v0.1.1
func DeleteOfflinePruning(db ethdb.KeyValueStore) error
DeleteOfflinePruning deletes any marker of the last attempt to run offline pruning.
func DeletePopulateMissingTries ¶ added in v0.2.1
func DeletePopulateMissingTries(db ethdb.KeyValueStore) error
DeletePopulateMissingTries deletes any marker of the last attempt to re-populate missing trie nodes.
func DeletePruningDisabled ¶ added in v0.2.1
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 DeleteStateID ¶ added in v0.6.3
func DeleteStateID(db ethdb.KeyValueWriter, root common.Hash)
DeleteStateID deletes the specified state lookup from the database.
func DeleteStorageSnapshot ¶
func DeleteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash)
DeleteStorageSnapshot removes the snapshot entry of an storage trie leaf.
func DeleteStorageTrieNode ¶ added in v0.5.3
func DeleteStorageTrieNode(db ethdb.KeyValueWriter, accountHash common.Hash, path []byte)
DeleteStorageTrieNode deletes the specified storage trie node from the database.
func DeleteTimeMarker ¶ added in v0.2.1
func DeleteTimeMarker(db ethdb.KeyValueStore, key []byte) error
DeleteTimeMarker deletes any value stored at [key]
func DeleteTrieJournal ¶ added in v0.6.3
func DeleteTrieJournal(db ethdb.KeyValueWriter)
DeleteTrieJournal deletes the serialized in-memory trie nodes of layers saved at the last shutdown.
func DeleteTrieNode ¶
func DeleteTrieNode(db ethdb.KeyValueWriter, owner common.Hash, path []byte, hash common.Hash, scheme string)
DeleteTrieNode deletes the trie node from database with the provided node info and associated node hash. hashScheme-based lookup requires the following:
- hash
pathScheme-based lookup requires the following:
- owner
- path
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 ExistsAccountTrieNode ¶ added in v0.6.4
func ExistsAccountTrieNode(db ethdb.KeyValueReader, path []byte) bool
ExistsAccountTrieNode checks the presence of the account trie node with the specified node path, regardless of the node hash.
func ExistsStorageTrieNode ¶ added in v0.6.4
ExistsStorageTrieNode checks the presence of the storage trie node with the specified account hash and node path, regardless of the node hash.
func FindCommonAncestor ¶
FindCommonAncestor returns the last common ancestor of two block headers
func GetLatestSyncPerformed ¶ added in v0.6.4
GetLatestSyncPerformed returns the latest block number state synced performed to.
func HasAccountTrieNode ¶ added in v0.5.3
HasAccountTrieNode checks the account trie node presence with the specified node path and the associated node hash.
func HasCode ¶ added in v0.3.0
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 HasLegacyTrieNode ¶ added in v0.5.3
func HasLegacyTrieNode(db ethdb.KeyValueReader, hash common.Hash) bool
HasLegacyTrieNode checks if the trie node with the provided hash is present in db.
func HasPruningDisabled ¶ added in v0.2.1
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 HasStorageTrieNode ¶ added in v0.5.3
func HasStorageTrieNode(db ethdb.KeyValueReader, accountHash common.Hash, path []byte, hash common.Hash) bool
HasStorageTrieNode checks the storage trie node presence with the provided node path and the associated node hash.
func HasTrieNode ¶ added in v0.1.2
func HasTrieNode(db ethdb.KeyValueReader, owner common.Hash, path []byte, hash common.Hash, scheme string) bool
HasTrieNode checks the trie node presence with the provided node info and the associated node hash.
func InspectDatabase ¶
InspectDatabase traverses the entire database and checks the size of all different categories of data.
func IsAccountTrieNode ¶ added in v0.5.9
IsAccountTrieNode reports whether a provided database entry is an account trie node in path-based state scheme.
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 IsLegacyTrieNode ¶ added in v0.5.9
IsLegacyTrieNode reports whether a provided database entry is a legacy trie node. The characteristics of legacy trie node are: - the key length is 32 bytes - the key is the hash of val
func IsStorageTrieNode ¶ added in v0.5.9
IsStorageTrieNode reports whether a provided database entry is a storage trie node in path-based state scheme.
func IterateAccountSnapshots ¶ added in v0.2.1
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 NewCodeToFetchIterator ¶ added in v0.3.0
NewCodeToFetchIterator returns a KeyLength iterator over all code hashes that are pending syncing. It is the caller's responsibility to unpack the key and call Release on the returned iterator.
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 ¶ added in v0.3.0
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 ¶ added in v0.1.1
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 NewPebbleDBDatabase ¶ added in v0.5.3
func NewPebbleDBDatabase(file string, cache int, handles int, namespace string, readonly, ephemeral bool) (ethdb.Database, error)
NewPebbleDBDatabase creates a persistent key-value database without a freezer moving immutable chain segments into cold storage.
func NewSyncPerformedIterator ¶ added in v0.4.4
NewSyncPerformedIterator returns an iterator over all block numbers the VM has state synced to.
func NewSyncSegmentsIterator ¶ added in v0.3.0
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.3.0
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 Open ¶ added in v0.5.3
func Open(o OpenOptions) (ethdb.Database, error)
Open opens both a disk-based key-value database such as leveldb or pebble, but also integrates it with a freezer database -- if the AncientDir option has been set on the provided OpenOptions. The passed o.AncientDir indicates the path of root ancient directory where the chain freezer can be opened.
func ParseStateScheme ¶ added in v0.6.5
ParseStateScheme checks if the specified state scheme is compatible with the stored state.
If the provided scheme is none, use the scheme consistent with persistent state, or fallback to hash-based scheme if state is empty.
If the provided scheme is hash, use hash-based scheme or error out if not compatible with persistent state scheme.
If the provided scheme is path: use path-based scheme or error out if not compatible with persistent state scheme.
func PopUncleanShutdownMarker ¶ added in v0.1.1
func PopUncleanShutdownMarker(db ethdb.KeyValueStore)
PopUncleanShutdownMarker removes the last unclean shutdown marker
func PreexistingDatabase ¶ added in v0.6.4
PreexistingDatabase checks the given data directory whether a database is already instantiated at that location, and if so, returns the type of database (or the empty string).
func PushUncleanShutdownMarker ¶ added in v0.1.1
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 ¶ added in v0.2.4
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 ReadAccountTrieNode ¶ added in v0.5.3
ReadAccountTrieNode retrieves the account trie node and the associated node hash with the specified node path.
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 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 ReadLegacyTrieNode ¶ added in v0.5.3
func ReadLegacyTrieNode(db ethdb.KeyValueReader, hash common.Hash) []byte
ReadLegacyTrieNode retrieves the legacy trie node with the given associated node hash.
func ReadLogs ¶
ReadLogs retrieves the logs for all transactions in a block. In case receipts is not found, a nil is returned. Note: ReadLogs does not derive unstored log fields.
func ReadOfflinePruning ¶ added in v0.1.1
func ReadOfflinePruning(db ethdb.KeyValueStore) (time.Time, error)
ReadOfflinePruning reads the most recent timestamp of an attempt to run offline pruning if present.
func ReadPersistentStateID ¶ added in v0.6.3
func ReadPersistentStateID(db ethdb.KeyValueReader) uint64
ReadPersistentStateID retrieves the id of the persistent state from the database.
func ReadPopulateMissingTries ¶ added in v0.2.1
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, time 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 ReadStateID ¶ added in v0.6.3
func ReadStateID(db ethdb.KeyValueReader, root common.Hash) *uint64
ReadStateID retrieves the state id with the provided state root.
func ReadStateScheme ¶ added in v0.6.4
ReadStateScheme reads the state scheme of persistent state, or none if the state is not present in database.
func ReadStorageSnapshot ¶
func ReadStorageSnapshot(db ethdb.KeyValueReader, accountHash, storageHash common.Hash) []byte
ReadStorageSnapshot retrieves the snapshot entry of an storage trie leaf.
func ReadStorageTrieNode ¶ added in v0.5.3
func ReadStorageTrieNode(db ethdb.KeyValueReader, accountHash common.Hash, path []byte) ([]byte, common.Hash)
ReadStorageTrieNode retrieves the storage trie node and the associated node hash with the specified node path.
func ReadSyncRoot ¶ added in v0.3.0
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 ¶ added in v0.2.1
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 ReadTrieJournal ¶ added in v0.6.3
func ReadTrieJournal(db ethdb.KeyValueReader) []byte
ReadTrieJournal retrieves the serialized in-memory trie nodes of layers saved at the last shutdown.
func ReadTrieNode ¶
func ReadTrieNode(db ethdb.KeyValueReader, owner common.Hash, path []byte, hash common.Hash, scheme string) []byte
ReadTrieNode retrieves the trie node from database with the provided node info and associated node hash. hashScheme-based lookup requires the following:
- hash
pathScheme-based lookup requires the following:
- owner
- path
func ReadTxIndexTail ¶
func ReadTxIndexTail(db ethdb.KeyValueReader) *uint64
ReadTxIndexTail retrieves the number of oldest indexed block whose transaction indices has been indexed.
func ReadTxLookupEntry ¶
ReadTxLookupEntry retrieves the positional metadata associated with a transaction hash to allow retrieving the transaction or receipt by hash.
func ResolveAccountTrieNodeKey ¶ added in v0.6.4
ResolveAccountTrieNodeKey reports whether a provided database entry is an account trie node in path-based state scheme, and returns the resolved node path if so.
func ResolveStorageTrieNode ¶ added in v0.6.4
ResolveStorageTrieNode reports whether a provided database entry is a storage trie node in path-based state scheme, and returns the resolved account hash and node path if so.
func UnindexTransactions ¶ added in v0.4.9
UnindexTransactions removes txlookup indices of the specified block range. The from is included while to is excluded.
There is a passed channel, the whole procedure will be interrupted if any signal received.
func UnpackSyncPerformedKey ¶ added in v0.4.4
UnpackSyncPerformedKey returns the block number from keys the iterator returned from NewSyncPerformedIterator.
func UnpackSyncSegmentKey ¶ added in v0.3.0
UnpackSyncSegmentKey returns the root and start position for a trie segment key returned from NewSyncSegmentsIterator.
func UnpackSyncStorageTrieKey ¶ added in v0.3.0
UnpackSyncStorageTrieKey returns the root and account for a storage trie key returned from NewSyncStorageTriesIterator.
func UpdateUncleanShutdownMarker ¶ added in v0.1.1
func UpdateUncleanShutdownMarker(db ethdb.KeyValueStore)
UpdateUncleanShutdownMarker updates the last marker's timestamp to now.
func WriteAcceptorTip ¶ added in v0.2.4
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 WriteAccountTrieNode ¶ added in v0.5.3
func WriteAccountTrieNode(db ethdb.KeyValueWriter, path []byte, node []byte)
WriteAccountTrieNode writes the provided account trie node into database.
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 WriteLegacyTrieNode ¶ added in v0.5.3
func WriteLegacyTrieNode(db ethdb.KeyValueWriter, hash common.Hash, node []byte)
WriteLegacyTrieNode writes the provided legacy trie node to database.
func WriteOfflinePruning ¶ added in v0.1.1
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 WritePersistentStateID ¶ added in v0.6.3
func WritePersistentStateID(db ethdb.KeyValueWriter, number uint64)
WritePersistentStateID stores the id of the persistent state into database.
func WritePopulateMissingTries ¶ added in v0.2.1
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 ¶ added in v0.2.1
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 WriteStateID ¶ added in v0.6.3
func WriteStateID(db ethdb.KeyValueWriter, root common.Hash, id uint64)
WriteStateID writes the provided state lookup to database.
func WriteStorageSnapshot ¶
func WriteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash, entry []byte)
WriteStorageSnapshot stores the snapshot entry of an storage trie leaf.
func WriteStorageTrieNode ¶ added in v0.5.3
func WriteStorageTrieNode(db ethdb.KeyValueWriter, accountHash common.Hash, path []byte, node []byte)
WriteStorageTrieNode writes the provided storage trie node into database.
func WriteSyncPerformed ¶ added in v0.4.4
func WriteSyncPerformed(db ethdb.KeyValueWriter, blockNumber uint64) error
WriteSyncPerformed logs an entry in [db] indicating the VM state synced to [blockNumber].
func WriteSyncRoot ¶ added in v0.3.0
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.3.0
WriteSyncSegment adds a trie segment for root at the given start position.
func WriteSyncStorageTrie ¶ added in v0.3.0
WriteSyncStorageTrie adds a storage trie for account (with the given root) to be synced.
func WriteTimeMarker ¶ added in v0.2.1
func WriteTimeMarker(db ethdb.KeyValueStore, key []byte) error
WriteTimeMarker writes a marker of the current time in the db at [key]
func WriteTrieJournal ¶ added in v0.6.3
func WriteTrieJournal(db ethdb.KeyValueWriter, journal []byte)
WriteTrieJournal stores the serialized in-memory trie nodes of layers to save at shutdown.
func WriteTrieNode ¶
func WriteTrieNode(db ethdb.KeyValueWriter, owner common.Hash, path []byte, hash common.Hash, node []byte, scheme string)
WriteTrieNode writes the trie node into database with the provided node info and associated node hash. hashScheme-based lookup requires the following:
- hash
pathScheme-based lookup requires the following:
- owner
- path
func WriteTxIndexTail ¶
func WriteTxIndexTail(db ethdb.KeyValueWriter, number uint64)
WriteTxIndexTail stores the number of oldest indexed block into 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 ¶ added in v0.3.0
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 ¶ added in v0.3.0
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 certain heights, both canonical and reorged forks included. This method considers both limits to be _inclusive_.
type OpenOptions ¶ added in v0.5.3
type OpenOptions struct { Type string // "leveldb" | "pebble" Directory string // the datadir Namespace string // the namespace for database relevant metrics Cache int // the capacity(in megabytes) of the data caching Handles int // number of files to be open simultaneously ReadOnly bool // Ephemeral means that filesystem sync operations should be avoided: data integrity in the face of // a crash is not important. This option should typically be used in tests. Ephemeral bool }
OpenOptions contains the options to apply when opening a database. OBS: If AncientsDirectory is empty, it indicates that no freezer is to be used.