rawdb

package
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 10, 2024 License: GPL-3.0, LGPL-3.0 Imports: 28 Imported by: 35

Documentation

Overview

Package rawdb contains a collection of low level database accessors.

Index

Constants

View Source 
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).

View Source 
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

View Source 
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.8.13 

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.14 

func ClearAllSyncSegments(db ethdb.KeyValueStore) error

ClearAllSyncSegments removes all segment markers from db

func ClearAllSyncStorageTries added in v0.8.14 

func ClearAllSyncStorageTries(db ethdb.KeyValueStore) error

ClearAllSyncStorageTries removes all storage tries added for syncing from db

func ClearPrefix added in v0.8.14 

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.8.14 

func ClearSyncSegments(db ethdb.KeyValueStore, root common.Hash) error

ClearSyncSegments removes segment markers for root from db

func ClearSyncStorageTrie added in v0.8.14 

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 added in v0.3.1 

func DeleteAccountSnapshot(db ethdb.KeyValueWriter, hash common.Hash)

DeleteAccountSnapshot removes the snapshot entry of an account trie leaf.

func DeleteAccountTrieNode added in v0.12.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 added in v0.3.1 

func DeleteBloombits(db ethdb.Database, bit uint, from uint64, to uint64)

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 added in v0.3.1 

func DeleteCode(db ethdb.KeyValueWriter, hash common.Hash)

DeleteCode deletes the specified contract code from the database.

func DeleteCodeToFetch added in v0.8.13 

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.12.3 

func DeleteLegacyTrieNode(db ethdb.KeyValueWriter, hash common.Hash)

DeleteLegacyTrieNode deletes the specified legacy trie node from database.

func DeleteOfflinePruning added in v0.8.5 

func DeleteOfflinePruning(db ethdb.KeyValueStore) error

DeleteOfflinePruning deletes any marker of the last attempt to run offline pruning.

func DeletePopulateMissingTries added in v0.8.7 

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.8.7 

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 added in v0.5.6 

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 added in v0.3.1 

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.13.2 

func DeleteStateID(db ethdb.KeyValueWriter, root common.Hash)

DeleteStateID deletes the specified state lookup from the database.

func DeleteStorageSnapshot added in v0.3.1 

func DeleteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash)

DeleteStorageSnapshot removes the snapshot entry of an storage trie leaf.

func DeleteStorageTrieNode added in v0.12.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.8.7 

func DeleteTimeMarker(db ethdb.KeyValueStore, key []byte) error

DeleteTimeMarker deletes any value stored at [key]

func DeleteTrieJournal added in v0.13.2 

func DeleteTrieJournal(db ethdb.KeyValueWriter)

DeleteTrieJournal deletes the serialized in-memory trie nodes of layers saved at the last shutdown.

func DeleteTrieNode added in v0.3.1 

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 added in v0.3.1 

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.13.3 

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.13.3 

func ExistsStorageTrieNode(db ethdb.KeyValueReader, accountHash common.Hash, path []byte) bool

ExistsStorageTrieNode checks the presence of the storage trie node with the specified account hash and node path, regardless of the node hash.

func FindCommonAncestor 

func FindCommonAncestor(db ethdb.Reader, a, b *types.Header) *types.Header

FindCommonAncestor returns the last common ancestor of two block headers

func GetLatestSyncPerformed added in v0.13.3 

func GetLatestSyncPerformed(db ethdb.Iteratee) uint64

GetLatestSyncPerformed returns the latest block number state synced performed to.

func HasAccountTrieNode added in v0.12.3 

func HasAccountTrieNode(db ethdb.KeyValueReader, path []byte, hash common.Hash) bool

HasAccountTrieNode checks the account trie node presence with the specified node path and the associated node hash.

func HasBody 

func HasBody(db ethdb.Reader, hash common.Hash, number uint64) bool

HasBody verifies the existence of a block body corresponding to the hash.

func HasCode added in v0.8.13 

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 HasHeader 

func HasHeader(db ethdb.Reader, hash common.Hash, number uint64) bool

HasHeader verifies the existence of a block header corresponding to the hash.

func HasLegacyTrieNode added in v0.12.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.8.7 

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 

func HasReceipts(db ethdb.Reader, hash common.Hash, number uint64) bool

HasReceipts verifies the existence of all the transaction receipts belonging to a block.

func HasStorageTrieNode added in v0.12.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.8.6 

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 IndexTransactions added in v0.3.1 

func IndexTransactions(db ethdb.Database, from uint64, to uint64, interrupt chan struct{}, report bool)

IndexTransactions creates txlookup indices of the specified block range. The from is included while to is excluded.

This function iterates canonical chain in reverse order, it has one main advantage: We can write tx index tail flag periodically even without the whole indexing procedure is finished. So that we can resume indexing procedure next time quickly.

There is a passed channel, the whole procedure will be interrupted if any signal received.

func InspectDatabase 

func InspectDatabase(db ethdb.Database, keyPrefix, keyStart []byte) error

InspectDatabase traverses the entire database and checks the size of all different categories of data.

func IsAccountTrieNode added in v0.12.5 

func IsAccountTrieNode(key []byte) bool

IsAccountTrieNode reports whether a provided database entry is an account trie node in path-based state scheme.

func IsCodeKey added in v0.3.1 

func IsCodeKey(key []byte) (bool, []byte)

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.12.5 

func IsLegacyTrieNode(key []byte, val []byte) bool

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.12.5 

func IsStorageTrieNode(key []byte) bool

IsStorageTrieNode reports whether a provided database entry is a storage trie node in path-based state scheme.

func IterateAccountSnapshots added in v0.8.7 

func IterateAccountSnapshots(db ethdb.Iteratee) ethdb.Iterator

IterateAccountSnapshots returns an iterator for walking all of the accounts in the snapshot

func IterateStorageSnapshots added in v0.3.1 

func IterateStorageSnapshots(db ethdb.Iteratee, accountHash common.Hash) ethdb.Iterator

IterateStorageSnapshots returns an iterator for walking the entire storage space of a specific account.

func NewCodeToFetchIterator added in v0.8.16 

func NewCodeToFetchIterator(db ethdb.Iteratee) ethdb.Iterator

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.8.13 

func NewKeyLengthIterator(it ethdb.Iterator, keyLen int) ethdb.Iterator

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 

func NewMemoryDatabase() ethdb.Database

NewMemoryDatabase creates an ephemeral in-memory key-value database without a freezer moving immutable chain segments into cold storage.

func NewMemoryDatabaseWithCap 

func NewMemoryDatabaseWithCap(size int) ethdb.Database

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.12.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.11.1 

func NewSyncPerformedIterator(db ethdb.Iteratee) ethdb.Iterator

NewSyncPerformedIterator returns an iterator over all block numbers the VM has state synced to.

func NewSyncSegmentsIterator added in v0.8.14 

func NewSyncSegmentsIterator(db ethdb.Iteratee, root common.Hash) ethdb.Iterator

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.14 

func NewSyncStorageTriesIterator(db ethdb.Iteratee, seek []byte) ethdb.Iterator

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 NewTable 

func NewTable(db ethdb.Database, prefix string) ethdb.Database

NewTable returns a database object that prefixes all keys with a given string.

func Open added in v0.12.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.13.4 

func ParseStateScheme(provided string, disk ethdb.Database) (string, error)

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.8.4 

func PopUncleanShutdownMarker(db ethdb.KeyValueStore)

PopUncleanShutdownMarker removes the last unclean shutdown marker

func PreexistingDatabase added in v0.13.3 

func PreexistingDatabase(path string) string

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.8.4 

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.8.11 

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 added in v0.3.1 

func ReadAccountSnapshot(db ethdb.KeyValueReader, hash common.Hash) []byte

ReadAccountSnapshot retrieves the snapshot entry of an account trie leaf.

func ReadAccountTrieNode added in v0.12.3 

func ReadAccountTrieNode(db ethdb.KeyValueReader, path []byte) ([]byte, common.Hash)

ReadAccountTrieNode retrieves the account trie node and the associated node hash with the specified node path.

func ReadAllCanonicalHashes added in v0.3.1 

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 

func ReadAllHashes(db ethdb.Iteratee, number uint64) []common.Hash

ReadAllHashes retrieves all the hashes assigned to blocks at a certain heights, both canonical and reorged forks included.

func ReadBlock 

func ReadBlock(db ethdb.Reader, hash common.Hash, number uint64) *types.Block

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 ReadBody 

func ReadBody(db ethdb.Reader, hash common.Hash, number uint64) *types.Body

ReadBody retrieves the block body corresponding to the hash.

func ReadBodyRLP 

func ReadBodyRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue

ReadBodyRLP retrieves the block body (transactions and uncles) in RLP encoding.

func ReadCanonicalBodyRLP added in v0.3.1 

func ReadCanonicalBodyRLP(db ethdb.Reader, number uint64) rlp.RawValue

ReadCanonicalBodyRLP retrieves the block body (transactions and uncles) for the canonical block at number, in RLP encoding.

func ReadCanonicalHash 

func ReadCanonicalHash(db ethdb.Reader, number uint64) common.Hash

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 added in v0.3.1 

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 added in v0.5.0 

func ReadHeadBlock(db ethdb.Reader) *types.Block

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 

func ReadHeader(db ethdb.Reader, hash common.Hash, number uint64) *types.Header

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 

func ReadHeaderRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue

ReadHeaderRLP retrieves a block header in its raw RLP database encoding.

func ReadLegacyTrieNode added in v0.12.3 

func ReadLegacyTrieNode(db ethdb.KeyValueReader, hash common.Hash) []byte

ReadLegacyTrieNode retrieves the legacy trie node with the given associated node hash.

func ReadLogs added in v0.7.1 

func ReadLogs(db ethdb.Reader, hash common.Hash, number uint64) [][]*types.Log

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.8.5 

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.13.2 

func ReadPersistentStateID(db ethdb.KeyValueReader) uint64

ReadPersistentStateID retrieves the id of the persistent state from the database.

func ReadPopulateMissingTries added in v0.8.7 

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 

func ReadRawReceipts(db ethdb.Reader, hash common.Hash, number uint64) types.Receipts

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 

func ReadReceiptsRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue

ReadReceiptsRLP retrieves all the transaction receipts belonging to a block in RLP encoding.

func ReadSnapshotBlockHash added in v0.5.6 

func ReadSnapshotBlockHash(db ethdb.KeyValueReader) common.Hash

ReadSnapshotBlockHash retrieves the hash of the block whose state is contained in the persisted snapshot.

func ReadSnapshotGenerator added in v0.5.0 

func ReadSnapshotGenerator(db ethdb.KeyValueReader) []byte

ReadSnapshotGenerator retrieves the serialized snapshot generator saved at the last shutdown.

func ReadSnapshotRoot added in v0.3.1 

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.13.2 

func ReadStateID(db ethdb.KeyValueReader, root common.Hash) *uint64

ReadStateID retrieves the state id with the provided state root.

func ReadStateScheme added in v0.13.3 

func ReadStateScheme(db ethdb.Reader) string

ReadStateScheme reads the state scheme of persistent state, or none if the state is not present in database.

func ReadStorageSnapshot added in v0.3.1 

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.12.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.8.14 

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.8.7 

func ReadTimeMarker(db ethdb.KeyValueStore, key []byte) (time.Time, error)

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.13.2 

func ReadTrieJournal(db ethdb.KeyValueReader) []byte

ReadTrieJournal retrieves the serialized in-memory trie nodes of layers saved at the last shutdown.

func ReadTrieNode added in v0.3.1 

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 added in v0.3.1 

func ReadTxIndexTail(db ethdb.KeyValueReader) *uint64

ReadTxIndexTail retrieves the number of oldest indexed block whose transaction indices has been indexed.

func ReadTxLookupEntry 

func ReadTxLookupEntry(db ethdb.Reader, hash common.Hash) *uint64

ReadTxLookupEntry retrieves the positional metadata associated with a transaction hash to allow retrieving the transaction or receipt by hash.

func ResolveAccountTrieNodeKey added in v0.13.3 

func ResolveAccountTrieNodeKey(key []byte) (bool, []byte)

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.13.3 

func ResolveStorageTrieNode(key []byte) (bool, common.Hash, []byte)

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.3.1 

func UnindexTransactions(db ethdb.Database, from uint64, to uint64, interrupt chan struct{}, report bool)

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.11.1 

func UnpackSyncPerformedKey(key []byte) uint64

UnpackSyncPerformedKey returns the block number from keys the iterator returned from NewSyncPerformedIterator.

func UnpackSyncSegmentKey added in v0.8.14 

func UnpackSyncSegmentKey(keyBytes []byte) (common.Hash, []byte)

UnpackSyncSegmentKey returns the root and start position for a trie segment key returned from NewSyncSegmentsIterator.

func UnpackSyncStorageTrieKey added in v0.8.14 

func UnpackSyncStorageTrieKey(keyBytes []byte) (common.Hash, common.Hash)

UnpackSyncStorageTrieKey returns the root and account for a storage trie key returned from NewSyncStorageTriesIterator.

func UpdateUncleanShutdownMarker added in v0.8.4 

func UpdateUncleanShutdownMarker(db ethdb.KeyValueStore)

UpdateUncleanShutdownMarker updates the last marker's timestamp to now.

func WriteAcceptorTip added in v0.8.11 

func WriteAcceptorTip(db ethdb.KeyValueWriter, hash common.Hash) error

WriteAcceptorTip writes hash as the last accepted block that has been fully processed.

func WriteAccountSnapshot added in v0.3.1 

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.12.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 WriteBody 

func WriteBody(db ethdb.KeyValueWriter, hash common.Hash, number uint64, body *types.Body)

WriteBody stores a block body into the database.

func WriteBodyRLP 

func WriteBodyRLP(db ethdb.KeyValueWriter, hash common.Hash, number uint64, rlp rlp.RawValue)

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 added in v0.3.1 

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.12.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.8.5 

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.13.2 

func WritePersistentStateID(db ethdb.KeyValueWriter, number uint64)

WritePersistentStateID stores the id of the persistent state into database.

func WritePopulateMissingTries added in v0.8.7 

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.8.7 

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 added in v0.5.6 

func WriteSnapshotBlockHash(db ethdb.KeyValueWriter, blockHash common.Hash)

WriteSnapshotBlockHash stores the root of the block whose state is contained in the persisted snapshot.

func WriteSnapshotGenerator added in v0.5.0 

func WriteSnapshotGenerator(db ethdb.KeyValueWriter, generator []byte)

WriteSnapshotGenerator stores the serialized snapshot generator to save at shutdown.

func WriteSnapshotRoot added in v0.3.1 

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.13.2 

func WriteStateID(db ethdb.KeyValueWriter, root common.Hash, id uint64)

WriteStateID writes the provided state lookup to database.

func WriteStorageSnapshot added in v0.3.1 

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.12.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.11.1 

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.8.14 

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.14 

func WriteSyncSegment(db ethdb.KeyValueWriter, root common.Hash, start []byte) error

WriteSyncSegment adds a trie segment for root at the given start position.

func WriteSyncStorageTrie added in v0.8.14 

func WriteSyncStorageTrie(db ethdb.KeyValueWriter, root common.Hash, account common.Hash) error

WriteSyncStorageTrie adds a storage trie for account (with the given root) to be synced.

func WriteTimeMarker added in v0.8.7 

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.13.2 

func WriteTrieJournal(db ethdb.KeyValueWriter, journal []byte)

WriteTrieJournal stores the serialized in-memory trie nodes of layers to save at shutdown.

func WriteTrieNode added in v0.3.1 

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 added in v0.3.1 

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 added in v0.3.1 

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.8.13 

type KeyLengthIterator struct {
	ethdb.Iterator
	// contains filtered or unexported fields
}

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.8.13 

func (it *KeyLengthIterator) Next() bool

type LegacyTxLookupEntry 

type LegacyTxLookupEntry struct {
	BlockHash  common.Hash
	BlockIndex uint64
	Index      uint64
}

LegacyTxLookupEntry is the legacy TxLookupEntry definition with some unnecessary fields.

type NumberHash added in v0.7.1 

type NumberHash struct {
	Number uint64
	Hash   common.Hash
}

func ReadAllHashesInRange added in v0.7.1 

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.12.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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.