rawdb

package
v1.10.3 Latest Latest
Warning

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

Go to latest
Published: Sep 25, 2024 License: LGPL-3.0 Imports: 38 Imported by: 0

Documentation

Overview

Package rawdb contains a collection of low level database accessors.

Index

Constants

View Source
const (
	SpentByte byte = iota
	UnspentByte
	NAByte // not exist
)

Indicate whether the receipts corresponding to a blockHash is spent or not

View Source
const (
	// ChainFreezerHeaderTable indicates the name of the freezer header table.
	ChainFreezerHeaderTable = "headers"

	// ChainFreezerHashTable indicates the name of the freezer canonical hash table.
	ChainFreezerHashTable = "hashes"

	// ChainFreezerBodiesTable indicates the name of the freezer block body table.
	ChainFreezerBodiesTable = "bodies"

	// ChainFreezerReceiptTable indicates the name of the freezer receipts table.
	ChainFreezerReceiptTable = "receipts"

	// ChainFreezerDifficultyTable indicates the name of the freezer total difficulty table.
	ChainFreezerDifficultyTable = "diffs"
)

The list of table names of chain freezer. This variables is NOT used, just ported over from the Ethereum

View Source
const HashScheme = "hashScheme"

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 = "pathScheme"

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.

View Source
const PebbleEnabled = true

Pebble is unsuported on 32bit architecture

Variables

View Source
var (

	// SnapshotRootKey tracks the hash of the last snapshot.
	SnapshotRootKey = []byte("SnapshotRoot")

	// 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

	// Data item prefixes (use single byte to avoid mixing data types, avoid `i`, used for indexes).
	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
	ValidatorCodePrefix   = []byte("vc") // ValidatorCodePrefix + code hash -> validator code

	PreimagePrefix = []byte("secure-key-") // PreimagePrefix + hash -> preimage

	ChtPrefix           = []byte("chtRootV2-") // ChtPrefix + chtNum (uint64 big endian) -> trie root hash
	ChtTablePrefix      = []byte("cht-")
	ChtIndexTablePrefix = []byte("chtIndexV2-")

	BloomTriePrefix      = []byte("bltRoot-") // BloomTriePrefix + bloomTrieNum (uint64 big endian) -> trie root hash
	BloomTrieTablePrefix = []byte("blt-")
	BloomTrieIndexPrefix = []byte("bltIndex-")

	CliqueSnapshotPrefix = []byte("clique-")
)

The fields below define the low level database schema prefixing.

View Source
var MsgNoShardStateFromDB = "failed to read shard state from DB"

MsgNoShardStateFromDB error message for shard state reading failure

Functions

func DeleteAccountSnapshot

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

DeleteAccountSnapshot removes the snapshot entry of an account trie leaf.

func DeleteAccountTrieNode

func DeleteAccountTrieNode(db ethdb.KeyValueWriter, path []byte)

DeleteAccountTrieNode deletes the specified account trie node from the database.

func DeleteBadBlocks

func DeleteBadBlocks(db ethdb.KeyValueWriter)

DeleteBadBlocks deletes all the bad blocks from the database This function is NOT used, just ported over from the Ethereum

func DeleteBlock

func DeleteBlock(db ethdb.KeyValueWriter, hash common.Hash, number uint64) error

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

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) error

DeleteBody removes all block body data associated with a hash.

func DeleteCXReceiptsProofSpent

func DeleteCXReceiptsProofSpent(db DatabaseDeleter, shardID uint32, number uint64) error

DeleteCXReceiptsProofSpent removes unspent indicator of a given blockHash

func DeleteCanonicalHash

func DeleteCanonicalHash(db ethdb.KeyValueWriter, number uint64) error

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 DeleteCrossLinkShardBlock

func DeleteCrossLinkShardBlock(db DatabaseDeleter, shardID uint32, blockNum uint64) error

DeleteCrossLinkShardBlock deletes the blockHash given shardID and blockNum

func DeleteCxLookupEntry

func DeleteCxLookupEntry(db DatabaseDeleter, hash common.Hash) error

DeleteCxLookupEntry removes all transaction data associated with a hash.

func DeleteHeader

func DeleteHeader(db ethdb.KeyValueWriter, hash common.Hash, number uint64) error

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

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

DeleteLegacyTrieNode deletes the specified legacy trie node from database.

func DeleteReceipts

func DeleteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64) error

DeleteReceipts removes all receipt data associated with a block hash.

func DeleteSkeletonHeader

func DeleteSkeletonHeader(db ethdb.KeyValueWriter, number uint64)

DeleteSkeletonHeader removes all block header data associated with a hash.

func DeleteSkeletonSyncStatus

func DeleteSkeletonSyncStatus(db ethdb.KeyValueWriter)

DeleteSkeletonSyncStatus deletes the serialized sync status saved at the last shutdown

func DeleteSnapshotDisabled

func DeleteSnapshotDisabled(db ethdb.KeyValueWriter)

DeleteSnapshotDisabled deletes the flag keeping the snapshot maintenance disabled.

func DeleteSnapshotGenerator

func DeleteSnapshotGenerator(db ethdb.KeyValueWriter)

DeleteSnapshotGenerator deletes the serialized snapshot generator saved at the last shutdown

func DeleteSnapshotJournal

func DeleteSnapshotJournal(db ethdb.KeyValueWriter)

DeleteSnapshotJournal deletes the serialized in-memory diff layers saved at the last shutdown

func DeleteSnapshotRecoveryNumber

func DeleteSnapshotRecoveryNumber(db ethdb.KeyValueWriter)

DeleteSnapshotRecoveryNumber deletes the block number of the last persisted snapshot layer.

func DeleteSnapshotRoot

func DeleteSnapshotRoot(db ethdb.KeyValueWriter)

DeleteSnapshotRoot 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 DeleteStorageSnapshot

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

DeleteStorageSnapshot removes the snapshot entry of an storage trie leaf.

func DeleteStorageTrieNode

func DeleteStorageTrieNode(db ethdb.KeyValueWriter, accountHash common.Hash, path []byte)

DeleteStorageTrieNode deletes the specified storage trie node from the database.

func DeleteTd

func DeleteTd(db ethdb.KeyValueWriter, hash common.Hash, number uint64) error

DeleteTd removes all block total difficulty data associated with a hash.

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) error

DeleteTxLookupEntry removes all transaction data associated with a hash.

func DeleteValidatorCode

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

DeleteValidatorCode deletes the specified validator code from the database.

func DeleteValidatorSnapshot

func DeleteValidatorSnapshot(db DatabaseDeleter, addr common.Address, epoch *big.Int) error

DeleteValidatorSnapshot removes the validator's snapshot by its address

func DeleteValidatorStats

func DeleteValidatorStats(db DatabaseDeleter, addr common.Address) error

DeleteValidatorStats ..

func FindCommonAncestor

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

FindCommonAncestor returns the last common ancestor of two block headers

func HasAccountTrieNode

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

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

func HasLegacyTrieNode(db ethdb.KeyValueReader, hash common.Hash) bool

HasLegacyTrieNode checks if the trie node with the provided hash is present in db.

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

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

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 HasValidatorCode

func HasValidatorCode(db ethdb.KeyValueReader, hash common.Hash) bool

HasValidatorCode checks if the validator code corresponding to the provided code hash is present in the db.

func HasValidatorCodeWithPrefix

func HasValidatorCodeWithPrefix(db ethdb.KeyValueReader, hash common.Hash) bool

HasValidatorCodeWithPrefix checks if the validator code corresponding to the provided code hash is present in the db. This function will only check presence using the prefix-scheme.

func IndexTransactions

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

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 InitDatabaseFromFreezer

func InitDatabaseFromFreezer(db ethdb.Database)

InitDatabaseFromFreezer reinitializes an empty database from a previous batch of frozen ancient blocks. The method iterates over all the frozen blocks and injects into the database the block hash->number mappings. This function is NOT used, just ported over from the Ethereum

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 IsCodeKey

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 IsValidatorCodeKey

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

IsValidatorCodeKey reports whether the given byte slice is the key of validator code, if so return the raw code hash as well.

func IterateStorageSnapshots

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 IteratorBlocks

func IteratorBlocks(iterator DatabaseIterator, cb func(blockNum uint64, hash common.Hash) bool) (minKey []byte, maxKey []byte)

func IteratorCXReceipt

func IteratorCXReceipt(iterator DatabaseIterator, cb func(it ethdb.Iterator, shardID uint32, number uint64, hash common.Hash) bool)

func IteratorCXReceiptsProofSpent

func IteratorCXReceiptsProofSpent(iterator DatabaseIterator, cb func(it ethdb.Iterator, shardID uint32, number uint64) bool)

func IteratorDelegatorDelegations

func IteratorDelegatorDelegations(iterator DatabaseIterator, cb func(it ethdb.Iterator, delegator common.Address) bool)

func IteratorValidatorSnapshot

func IteratorValidatorSnapshot(iterator DatabaseIterator, cb func(addr common.Address, epoch *big.Int) bool) (minKey []byte, maxKey []byte)

func IteratorValidatorStats

func IteratorValidatorStats(iterator DatabaseIterator, cb func(it ethdb.Iterator, addr common.Address) bool)

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

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

func NewPebbleDBDatabase(file string, cache int, handles int, namespace string, readonly bool) (ethdb.Database, error)

NewPebbleDBDatabase creates a persistent key-value database without a freezer moving immutable chain segments into cold storage.

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 PopUncleanShutdownMarker

func PopUncleanShutdownMarker(db ethdb.KeyValueStore)

PopUncleanShutdownMarker removes the last unclean shutdown marker This function is NOT used, just ported over from the Ethereum

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 This function is NOT used, just ported over from the Ethereum

func ReadAccountSnapshot

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

ReadAccountSnapshot retrieves the snapshot entry of an account trie leaf.

func ReadAccountTrieNode

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

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 ReadBlockCommitSig

func ReadBlockCommitSig(db DatabaseReader, blockNum uint64) ([]byte, error)

ReadBlockCommitSig retrieves the signature signed on a block.

func ReadBlockRewardAccumulator

func ReadBlockRewardAccumulator(db DatabaseReader, number uint64) (*big.Int, error)

ReadBlockRewardAccumulator ..

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 ReadCXReceipt

func ReadCXReceipt(db ethdb.Reader, hash common.Hash) (*types.CXReceipt, common.Hash, uint64, uint64)

ReadCXReceipt retrieves a specific transaction from the database, along with its added positional metadata.

func ReadCXReceipts

func ReadCXReceipts(db DatabaseReader, shardID uint32, number uint64, hash common.Hash) (types.CXReceipts, error)

ReadCXReceipts retrieves all the transactions of receipts given destination shardID, number and blockHash

func ReadCXReceiptsProofSpent

func ReadCXReceiptsProofSpent(db DatabaseReader, shardID uint32, number uint64) (byte, error)

ReadCXReceiptsProofSpent check whether a CXReceiptsProof is unspent

func ReadCanonicalBodyRLP

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

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 ReadCrossLinkShardBlock

func ReadCrossLinkShardBlock(
	db DatabaseReader, shardID uint32, blockNum uint64,
) ([]byte, error)

ReadCrossLinkShardBlock retrieves the blockHash given shardID and blockNum

func ReadCxLookupEntry

func ReadCxLookupEntry(db DatabaseReader, hash common.Hash) (common.Hash, uint64, uint64)

ReadCxLookupEntry retrieves the positional metadata associated with a transaction hash to allow retrieving cross shard receipt by hash in destination shard not the original transaction in source shard return nil if not found

func ReadDatabaseVersion

func ReadDatabaseVersion(db ethdb.KeyValueReader) *uint64

ReadDatabaseVersion retrieves the version number of the database.

func ReadDelegationsByDelegator

func ReadDelegationsByDelegator(db DatabaseReader, delegator common.Address) (staking.DelegationIndexes, error)

ReadDelegationsByDelegator retrieves the list of validators delegated by a delegator Returns empty results instead of error if there is not data found.

func ReadEpochBlockNumber

func ReadEpochBlockNumber(db DatabaseReader, epoch *big.Int) (*big.Int, error)

ReadEpochBlockNumber retrieves the epoch block number for the given epoch, or nil if the given epoch is not found in the database.

func ReadEpochVdfBlockNum

func ReadEpochVdfBlockNum(db DatabaseReader, epoch *big.Int) ([]byte, error)

ReadEpochVdfBlockNum retrieves the VDF block number for the given epoch

func ReadEpochVrfBlockNums

func ReadEpochVrfBlockNums(db DatabaseReader, epoch *big.Int) ([]byte, error)

ReadEpochVrfBlockNums retrieves the VRF block numbers for the given epoch

func ReadFastTxLookupLimit

func ReadFastTxLookupLimit(db ethdb.KeyValueReader) *uint64

ReadFastTxLookupLimit retrieves the tx lookup limit used in fast sync.

func ReadFinalizedBlockHash

func ReadFinalizedBlockHash(db ethdb.KeyValueReader) common.Hash

ReadFinalizedBlockHash retrieves the hash of the finalized block.

func ReadGenesisStateSpec

func ReadGenesisStateSpec(db ethdb.KeyValueReader, blockhash common.Hash) []byte

ReadGenesisStateSpec retrieves the genesis state specification based on the given genesis (block-)hash.

func ReadHeadBlock

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 ReadHeadFastBlockHash

func ReadHeadFastBlockHash(db ethdb.KeyValueReader) common.Hash

ReadHeadFastBlockHash retrieves the hash of the current fast-sync head block.

func ReadHeadHeader

func ReadHeadHeader(db ethdb.Reader) *block.Header

ReadHeadHeader returns the current canonical head header.

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) *block.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 ReadLastPivotNumber

func ReadLastPivotNumber(db ethdb.KeyValueReader) *uint64

ReadLastPivotNumber retrieves the number of the last pivot block. If the node full synced, the last pivot will always be nil.

func ReadLeaderRotationMeta

func ReadLeaderRotationMeta(db DatabaseReader) (pubKeyBytes []byte, epoch, count, shifts uint64, err error)

ReadLeaderRotationMeta retrieves the leader continuous blocks count from the database.

func ReadLegacyTrieNode

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

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

func ReadLogs

func ReadLogs(db ethdb.Reader, hash common.Hash, number uint64, config *params.ChainConfig) [][]*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 ReadPendingCrossLinks(db DatabaseReader) ([]byte, error)

ReadPendingCrossLinks retrieves last pending crosslinks.

func ReadPreImageEndBlock

func ReadPreImageEndBlock(db ethdb.KeyValueReader) (uint64, error)

func ReadPreImageStartBlock

func ReadPreImageStartBlock(db ethdb.KeyValueReader) (uint64, error)

func ReadPreimage

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

ReadPreimage retrieves a single preimage of the provided hash.

func ReadPreimageImportBlock

func ReadPreimageImportBlock(db ethdb.KeyValueReader) (uint64, error)

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, config *params.ChainConfig) types.Receipts

ReadReceipts retrieves all the transaction receipts belonging to a block.

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 ReadShardLastCrossLink(db DatabaseReader, shardID uint32) ([]byte, error)

ReadShardLastCrossLink read the last cross link of a shard

func ReadShardState

func ReadShardState(
	db DatabaseReader, epoch *big.Int,
) (*shard.State, error)

ReadShardState retrieves shard state of a specific epoch.

func ReadSkeletonHeader

func ReadSkeletonHeader(db ethdb.KeyValueReader, number uint64) *types.Header

ReadSkeletonHeader retrieves a block header from the skeleton sync store,

func ReadSkeletonSyncStatus

func ReadSkeletonSyncStatus(db ethdb.KeyValueReader) []byte

ReadSkeletonSyncStatus retrieves the serialized sync status saved at shutdown.

func ReadSnapshotDisabled

func ReadSnapshotDisabled(db ethdb.KeyValueReader) bool

ReadSnapshotDisabled retrieves if the snapshot maintenance is disabled.

func ReadSnapshotGenerator

func ReadSnapshotGenerator(db ethdb.KeyValueReader) []byte

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

func ReadSnapshotJournal

func ReadSnapshotJournal(db ethdb.KeyValueReader) []byte

ReadSnapshotJournal retrieves the serialized in-memory diff layers saved at the last shutdown. The blob is expected to be max a few 10s of megabytes.

func ReadSnapshotRecoveryNumber

func ReadSnapshotRecoveryNumber(db ethdb.KeyValueReader) *uint64

ReadSnapshotRecoveryNumber retrieves the block number of the last persisted snapshot layer.

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 ReadSnapshotSyncStatus

func ReadSnapshotSyncStatus(db ethdb.KeyValueReader) []byte

ReadSnapshotSyncStatus retrieves the serialized sync status saved at shutdown.

func ReadStakingTransaction

func ReadStakingTransaction(db ethdb.Reader, hash common.Hash) (*staking.StakingTransaction, common.Hash, uint64, uint64)

ReadStakingTransaction retrieves a specific staking transaction from the database, along with its added positional metadata.

func ReadStorageSnapshot

func ReadStorageSnapshot(db ethdb.KeyValueReader, accountHash, storageHash common.Hash) []byte

ReadStorageSnapshot retrieves the snapshot entry of an storage trie leaf.

func ReadStorageTrieNode

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 ReadTd

func ReadTd(db ethdb.Reader, hash common.Hash, number uint64) *big.Int

ReadTd retrieves a block's total difficulty corresponding to the hash.

func ReadTdRLP

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

ReadTdRLP retrieves a block's total difficulty corresponding to the hash in RLP encoding.

func ReadTransaction

func ReadTransaction(db ethdb.Reader, hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)

ReadTransaction retrieves a specific transaction from the database, along with its added positional metadata.

func ReadTransitionStatus

func ReadTransitionStatus(db ethdb.KeyValueReader) []byte

ReadTransitionStatus retrieves the eth2 transition status from the database This function is NOT used, just ported over from the Ethereum

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

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

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

func ReadValidatorCode

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

ReadValidatorCode retrieves the validator code of the provided code hash.

func ReadValidatorCodeWithPrefix

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

ReadValidatorCodeWithPrefix retrieves the validator code of the provided code hash. The main difference between this function and ReadValidatorCode is this function will only check the existence with latest scheme(with prefix).

func ReadValidatorList

func ReadValidatorList(db DatabaseReader) ([]common.Address, error)

ReadValidatorList retrieves all staking validators by its address

func ReadValidatorSnapshot

func ReadValidatorSnapshot(
	db DatabaseReader, addr common.Address, epoch *big.Int,
) (*staking.ValidatorSnapshot, error)

ReadValidatorSnapshot retrieves validator's snapshot by its address

func ReadValidatorStats

func ReadValidatorStats(
	db DatabaseReader, addr common.Address,
) (*staking.ValidatorStats, error)

ReadValidatorStats retrieves validator's stats by its address,

func UnindexTransactions

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

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 UpdateUncleanShutdownMarker

func UpdateUncleanShutdownMarker(db ethdb.KeyValueStore)

UpdateUncleanShutdownMarker updates the last marker's timestamp to now. This function is NOT used, just ported over from the Ethereum

func WriteAccountSnapshot

func WriteAccountSnapshot(db ethdb.KeyValueWriter, hash common.Hash, entry []byte)

WriteAccountSnapshot stores the snapshot entry of an account trie leaf.

func WriteAccountTrieNode

func WriteAccountTrieNode(db ethdb.KeyValueWriter, path []byte, node []byte)

WriteAccountTrieNode writes the provided account trie node into database.

func WriteBadBlock

func WriteBadBlock(db ethdb.KeyValueStore, block *types.Block)

WriteBadBlock serializes the bad block into the database. If the cumulated bad blocks exceeds the limitation, the oldest will be dropped. This function is NOT used, just ported over from the Ethereum

func WriteBlock

func WriteBlock(db ethdb.KeyValueWriter, block *types.Block) error

WriteBlock serializes a block into the database, header and body separately.

func WriteBlockCommitSig

func WriteBlockCommitSig(db DatabaseWriter, blockNum uint64, sigAndBitmap []byte) error

WriteBlockCommitSig ..

func WriteBlockRewardAccumulator

func WriteBlockRewardAccumulator(db DatabaseWriter, newAccum *big.Int, number uint64) error

WriteBlockRewardAccumulator ..

func WriteBlockStxLookUpEntries

func WriteBlockStxLookUpEntries(db DatabaseWriter, block *types.Block) error

WriteBlockStxLookUpEntries writes all look up entries of block's staking transactions

func WriteBlockTxLookUpEntries

func WriteBlockTxLookUpEntries(db DatabaseWriter, block *types.Block) error

WriteBlockTxLookUpEntries writes all look up entries of block's transactions

func WriteBloomBits

func WriteBloomBits(db ethdb.KeyValueWriter, bit uint, section uint64, head common.Hash, bits []byte) error

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) error

WriteBody storea a block body into the database.

func WriteBodyRLP

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

WriteBodyRLP stores an RLP encoded block body into the database.

func WriteCXReceipts

func WriteCXReceipts(db DatabaseWriter, shardID uint32, number uint64, hash common.Hash, receipts types.CXReceipts) error

WriteCXReceipts stores all the transaction receipts given destination shardID, blockNumber and blockHash

func WriteCXReceiptsProofSpent

func WriteCXReceiptsProofSpent(dbw DatabaseWriter, cxp *types.CXReceiptsProof) error

WriteCXReceiptsProofSpent write CXReceiptsProof as spent into database

func WriteCanonicalHash

func WriteCanonicalHash(db ethdb.KeyValueWriter, hash common.Hash, number uint64) error

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 WriteCrossLinkShardBlock

func WriteCrossLinkShardBlock(db DatabaseWriter, shardID uint32, blockNum uint64, data []byte) error

WriteCrossLinkShardBlock stores the blockHash given shardID and blockNum

func WriteCxLookupEntries

func WriteCxLookupEntries(db DatabaseWriter, block *types.Block) error

WriteCxLookupEntries stores a positional metadata for every transaction from a block, enabling hash based transaction and receipt lookups.

func WriteDatabaseVersion

func WriteDatabaseVersion(db ethdb.KeyValueWriter, version uint64)

WriteDatabaseVersion stores the version number of the database

func WriteDelegationsByDelegator

func WriteDelegationsByDelegator(db DatabaseWriter, delegator common.Address, indexes staking.DelegationIndexes) error

WriteDelegationsByDelegator stores the list of validators delegated by a delegator

func WriteEpochBlockNumber

func WriteEpochBlockNumber(db DatabaseWriter, epoch, blockNum *big.Int) error

WriteEpochBlockNumber stores the given epoch-number-to-epoch-block-number in the database.

func WriteEpochVdfBlockNum

func WriteEpochVdfBlockNum(db DatabaseWriter, epoch *big.Int, data []byte) error

WriteEpochVdfBlockNum stores the VDF block number for the given epoch

func WriteEpochVrfBlockNums

func WriteEpochVrfBlockNums(db DatabaseWriter, epoch *big.Int, data []byte) error

WriteEpochVrfBlockNums stores the VRF block numbers for the given epoch

func WriteFastTxLookupLimit

func WriteFastTxLookupLimit(db ethdb.KeyValueWriter, number uint64)

WriteFastTxLookupLimit stores the txlookup limit used in fast sync into database.

func WriteFinalizedBlockHash

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

WriteFinalizedBlockHash stores the hash of the finalized block.

func WriteGenesisStateSpec

func WriteGenesisStateSpec(db ethdb.KeyValueWriter, blockhash common.Hash, data []byte)

WriteGenesisStateSpec writes the genesis state specification into the disk.

func WriteHeadBlockHash

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

WriteHeadBlockHash stores the head block's hash.

func WriteHeadFastBlockHash

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

WriteHeadFastBlockHash stores the hash of the current fast-sync head block.

func WriteHeadHeaderHash

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

WriteHeadHeaderHash stores the hash of the current canonical head header.

func WriteHeader

func WriteHeader(db ethdb.KeyValueWriter, header *block.Header) error

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) error

WriteHeaderNumber stores reference from hash to number.

func WriteLastPivotNumber

func WriteLastPivotNumber(db ethdb.KeyValueWriter, pivot uint64) error

WriteLastPivotNumber stores the number of the last pivot block.

func WriteLeaderRotationMeta

func WriteLeaderRotationMeta(db DatabaseWriter, leader []byte, epoch uint64, count, shifts uint64) error

WriteLeaderRotationMeta writes the leader continuous blocks count to the database.

func WriteLegacyTrieNode

func WriteLegacyTrieNode(db ethdb.KeyValueWriter, hash common.Hash, node []byte)

WriteLegacyTrieNode writes the provided legacy trie node to database.

func WritePendingCrossLinks(db DatabaseWriter, bytes []byte) error

WritePendingCrossLinks stores last pending crosslinks into database.

func WritePendingSlashingCandidates

func WritePendingSlashingCandidates(db DatabaseWriter, bytes []byte) error

WritePendingSlashingCandidates stores last pending slashing candidates into database.

func WritePreImageStartEndBlock

func WritePreImageStartEndBlock(
	db ethdb.KeyValueStore,
	start uint64,
	end uint64,
) (
	uint64,
	uint64,
	error,
)

func WritePreimageImportBlock

func WritePreimageImportBlock(db ethdb.KeyValueWriter, number uint64) error

func WritePreimages

func WritePreimages(db ethdb.KeyValueWriter, preimages map[common.Hash][]byte) error

WritePreimages writes the provided set of preimages to the database.

func WriteReceipts

func WriteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64, receipts types.Receipts) error

WriteReceipts stores all the transaction receipts belonging to a block.

func WriteShardLastCrossLink(db DatabaseWriter, shardID uint32, data []byte) error

WriteShardLastCrossLink stores the last cross link of a shard

func WriteShardStateBytes

func WriteShardStateBytes(db DatabaseWriter, epoch *big.Int, data []byte) error

WriteShardStateBytes stores sharding state into database.

func WriteSkeletonHeader

func WriteSkeletonHeader(db ethdb.KeyValueWriter, header *types.Header)

WriteSkeletonHeader stores a block header into the skeleton sync store.

func WriteSkeletonSyncStatus

func WriteSkeletonSyncStatus(db ethdb.KeyValueWriter, status []byte)

WriteSkeletonSyncStatus stores the serialized sync status to save at shutdown.

func WriteSnapdbInfo

func WriteSnapdbInfo(db DatabaseWriter, info *SnapdbInfo) error

WriteSnapdbInfo write the SnapdbInfo into db

func WriteSnapshotDisabled

func WriteSnapshotDisabled(db ethdb.KeyValueWriter)

WriteSnapshotDisabled stores the snapshot pause flag.

func WriteSnapshotGenerator

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

WriteSnapshotGenerator stores the serialized snapshot generator to save at shutdown.

func WriteSnapshotJournal

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

WriteSnapshotJournal stores the serialized in-memory diff layers to save at shutdown. The blob is expected to be max a few 10s of megabytes.

func WriteSnapshotRecoveryNumber

func WriteSnapshotRecoveryNumber(db ethdb.KeyValueWriter, number uint64)

WriteSnapshotRecoveryNumber stores the block number of the last persisted snapshot layer.

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 WriteSnapshotSyncStatus

func WriteSnapshotSyncStatus(db ethdb.KeyValueWriter, status []byte)

WriteSnapshotSyncStatus stores the serialized sync status to save at shutdown.

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

func WriteStorageTrieNode(db ethdb.KeyValueWriter, accountHash common.Hash, path []byte, node []byte)

WriteStorageTrieNode writes the provided storage trie node into database.

func WriteTd

func WriteTd(db ethdb.KeyValueWriter, hash common.Hash, number uint64, td *big.Int) error

WriteTd stores the total difficulty of a block into the database.

func WriteTransitionStatus

func WriteTransitionStatus(db ethdb.KeyValueWriter, data []byte)

WriteTransitionStatus stores the eth2 transition status to the database This function is NOT used, just ported over from the Ethereum

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.

func WriteValidatorCode

func WriteValidatorCode(db ethdb.KeyValueWriter, hash common.Hash, code []byte)

WriteValidatorCode writes the provided validator code to database.

func WriteValidatorList

func WriteValidatorList(
	db DatabaseWriter, addrs []common.Address,
) error

WriteValidatorList stores all staking validators by its address

func WriteValidatorSnapshot

func WriteValidatorSnapshot(batch DatabaseWriter, v *staking.ValidatorWrapper, epoch *big.Int) error

WriteValidatorSnapshot stores validator's snapshot by its address

func WriteValidatorStats

func WriteValidatorStats(
	batch DatabaseWriter, addr common.Address, stats *staking.ValidatorStats,
) error

WriteValidatorStats stores validator's stats by its address

Types

type DatabaseDeleter

type DatabaseDeleter interface {
	Put(key []byte, value []byte) error
	Delete(key []byte) error
}

DatabaseDeleter wraps the Delete method of a backing data store.

type DatabaseIterator

type DatabaseIterator interface {
	NewIterator(prefix []byte, start []byte) ethdb.Iterator
}

type DatabaseReader

type DatabaseReader interface {
	Has(key []byte) (bool, error)
	Get(key []byte) ([]byte, error)
}

DatabaseReader wraps the Has and Get method of a backing data store.

type DatabaseWriter

type DatabaseWriter interface {
	Put(key []byte, value []byte) error
	Delete(key []byte) error
}

DatabaseWriter wraps the Put method of a backing data store.

type KeyLengthIterator

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

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

type NumberHash struct {
	Number uint64
	Hash   common.Hash
}

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

type OpenOptions struct {
	Type              string // "leveldb" | "pebble"
	Directory         string // the datadir
	AncientsDirectory string // the ancients-dir
	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
}

OpenOptions contains the options to apply when opening a database. OBS: If AncientsDirectory is empty, it indicates that no freezer is to be used.

type SnapdbInfo

type SnapdbInfo struct {
	NetworkType         nodeconfig.NetworkType // network type
	BlockHeader         *block.Header          // latest header at snapshot
	AccountCount        uint64                 // number of dumped account
	OffchainDataDumped  bool                   // is OffchainData dumped
	IndexerDataDumped   bool                   // is IndexerData dumped
	StateDataDumped     bool                   // is StateData dumped
	DumpedSize          uint64                 // size of key-value already dumped
	LastAccountKey      hexutil.Bytes          // MPT key of the account last dumped, use this to continue dumping
	LastAccountStateKey hexutil.Bytes          // MPT key of the account's state last dumped, use this to continue dumping
}

SnapdbInfo only used by cmd/intelchain/dumpdb.go

func ReadSnapdbInfo

func ReadSnapdbInfo(db DatabaseReader) *SnapdbInfo

ReadSnapdbInfo return the SnapdbInfo of the db

type TxLookupEntry

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

TxLookupEntry is a positional metadata to help looking up the data content of a transaction or receipt given only its hash.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL