go-ethereum: github.com/ethereum/go-ethereum/core/rawdb Index | Files

package rawdb

import "github.com/ethereum/go-ethereum/core/rawdb"

Package rawdb contains a collection of low level database accessors.

Index

Package Files

accessors_chain.go accessors_indexes.go accessors_metadata.go accessors_snapshot.go accessors_state.go chain_iterator.go database.go freezer.go freezer_table.go schema.go table.go

Variables

var (
    SnapshotAccountPrefix = []byte("a") // SnapshotAccountPrefix + account hash -> account trie value
    SnapshotStoragePrefix = []byte("o") // SnapshotStoragePrefix + account hash + storage hash -> storage trie value

    // Chain index prefixes (use `i` + single byte to avoid mixing data types).
    BloomBitsIndexPrefix = []byte("iB") // BloomBitsIndexPrefix is the data table of a chain indexer to track its progress

)

The fields below define the low level database schema prefixing.

func DeleteAccountSnapshot Uses

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

DeleteAccountSnapshot removes the snapshot entry of an account trie leaf.

func DeleteBlock Uses

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

DeleteBlock removes all block data associated with a hash.

func DeleteBlockWithoutNumber Uses

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 Uses

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 Uses

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

DeleteBody removes all block body data associated with a hash.

func DeleteCanonicalHash Uses

func DeleteCanonicalHash(db ethdb.KeyValueWriter, number uint64)

DeleteCanonicalHash removes the number to hash canonical mapping.

func DeleteCode Uses

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

DeleteCode deletes the specified contract code from the database.

func DeleteHeader Uses

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

DeleteHeader removes all block header data associated with a hash.

func DeleteHeaderNumber Uses

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

DeleteHeaderNumber removes hash->number mapping.

func DeleteReceipts Uses

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

DeleteReceipts removes all receipt data associated with a block hash.

func DeleteSnapshotJournal Uses

func DeleteSnapshotJournal(db ethdb.KeyValueWriter)

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

func DeleteSnapshotRoot Uses

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 Uses

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

DeleteStorageSnapshot removes the snapshot entry of an storage trie leaf.

func DeleteTd Uses

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

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

func DeleteTrieNode Uses

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

DeleteTrieNode deletes the specified trie node from the database.

func DeleteTxLookupEntries Uses

func DeleteTxLookupEntries(db ethdb.KeyValueWriter, hashes []common.Hash)

DeleteTxLookupEntries removes all transaction lookups for a given block.

func DeleteTxLookupEntry Uses

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

DeleteTxLookupEntry removes all transaction data associated with a hash.

func FindCommonAncestor Uses

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

FindCommonAncestor returns the last common ancestor of two block headers

func HasBody Uses

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

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

func HasHeader Uses

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

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

func HasReceipts Uses

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

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

IndexTransactions creates txlookup indices of the specified block range.

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 Uses

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.

func InspectDatabase Uses

func InspectDatabase(db ethdb.Database) error

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

func IsCodeKey Uses

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

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

func NewDatabase(db ethdb.KeyValueStore) ethdb.Database

NewDatabase creates a high level database on top of a given key-value data store without a freezer moving immutable chain segments into cold storage.

func NewDatabaseWithFreezer Uses

func NewDatabaseWithFreezer(db ethdb.KeyValueStore, freezer string, namespace string) (ethdb.Database, error)

NewDatabaseWithFreezer creates a high level database on top of a given key- value data store with a freezer moving immutable chain segments into cold storage.

func NewLevelDBDatabase Uses

func NewLevelDBDatabase(file string, cache int, handles int, namespace string) (ethdb.Database, error)

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

func NewLevelDBDatabaseWithFreezer Uses

func NewLevelDBDatabaseWithFreezer(file string, cache int, handles int, freezer string, namespace string) (ethdb.Database, error)

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

func NewMemoryDatabase Uses

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 Uses

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

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

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

func ReadAccountSnapshot Uses

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

ReadAccountSnapshot retrieves the snapshot entry of an account trie leaf.

func ReadAllCanonicalHashes Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

ReadBody retrieves the block body corresponding to the hash.

func ReadBodyRLP Uses

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 Uses

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 Uses

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

ReadCanonicalHash retrieves the hash assigned to a canonical block number.

func ReadChainConfig Uses

func ReadChainConfig(db ethdb.KeyValueReader, hash common.Hash) *params.ChainConfig

ReadChainConfig retrieves the consensus settings based on the given genesis hash.

func ReadCode Uses

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

ReadCode retrieves the contract code of the provided code hash.

func ReadCodeWithPrefix Uses

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

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

func ReadDatabaseVersion Uses

func ReadDatabaseVersion(db ethdb.KeyValueReader) *uint64

ReadDatabaseVersion retrieves the version number of the database.

func ReadFastTrieProgress Uses

func ReadFastTrieProgress(db ethdb.KeyValueReader) uint64

ReadFastTrieProgress retrieves the number of tries nodes fast synced to allow reporting correct numbers across restarts.

func ReadFastTxLookupLimit Uses

func ReadFastTxLookupLimit(db ethdb.KeyValueReader) *uint64

ReadFastTxLookupLimit retrieves the tx lookup limit used in fast sync.

func ReadHeadBlockHash Uses

func ReadHeadBlockHash(db ethdb.KeyValueReader) common.Hash

ReadHeadBlockHash retrieves the hash of the current canonical head block.

func ReadHeadFastBlockHash Uses

func ReadHeadFastBlockHash(db ethdb.KeyValueReader) common.Hash

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

func ReadHeadHeaderHash Uses

func ReadHeadHeaderHash(db ethdb.KeyValueReader) common.Hash

ReadHeadHeaderHash retrieves the hash of the current canonical head header.

func ReadHeader Uses

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

ReadHeader retrieves the block header corresponding to the hash.

func ReadHeaderNumber Uses

func ReadHeaderNumber(db ethdb.KeyValueReader, hash common.Hash) *uint64

ReadHeaderNumber returns the header number assigned to a hash.

func ReadHeaderRLP Uses

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 Uses

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

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

ReadPreimage retrieves a single preimage of the provided hash.

func ReadRawReceipts Uses

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 Uses

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 Uses

func ReadReceipts(db ethdb.Reader, hash common.Hash, number uint64, config *params.ChainConfig) types.Receipts

ReadReceipts retrieves all the transaction receipts belonging to a block, including its correspoinding metadata fields. If it is unable to populate these metadata fields then nil is returned.

The current implementation populates these metadata fields by reading the receipts' corresponding block body, so if the block body is not found it will return nil even if the receipt itself is stored.

func ReadReceiptsRLP Uses

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

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

func ReadSnapshotRoot(db ethdb.KeyValueReader) common.Hash

ReadSnapshotRoot retrieves the root of the block whose state is contained in the persisted snapshot.

func ReadStorageSnapshot Uses

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

ReadStorageSnapshot retrieves the snapshot entry of an storage trie leaf.

func ReadTd Uses

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 Uses

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 Uses

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

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

func ReadTrieNode Uses

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

ReadTrieNode retrieves the trie node of the provided hash.

func ReadTxIndexTail Uses

func ReadTxIndexTail(db ethdb.KeyValueReader) *uint64

ReadTxIndexTail retrieves the number of oldest indexed block whose transaction indices has been indexed. If the corresponding entry is non-existent in database it means the indexing has been finished.

func ReadTxLookupEntry Uses

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

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

UnindexTransactions removes txlookup indices of the specified block range.

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

func WriteAccountSnapshot Uses

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

WriteAccountSnapshot stores the snapshot entry of an account trie leaf.

func WriteAncientBlock Uses

func WriteAncientBlock(db ethdb.AncientWriter, block *types.Block, receipts types.Receipts, td *big.Int) int

WriteAncientBlock writes entire block data into ancient store and returns the total written size.

func WriteBlock Uses

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

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

func WriteBloomBits Uses

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 Uses

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

WriteBody stores a block body into the database.

func WriteBodyRLP Uses

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 Uses

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

WriteCanonicalHash stores the hash assigned to a canonical block number.

func WriteChainConfig Uses

func WriteChainConfig(db ethdb.KeyValueWriter, hash common.Hash, cfg *params.ChainConfig)

WriteChainConfig writes the chain config settings to the database.

func WriteCode Uses

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

WriteCode writes the provided contract code database.

func WriteDatabaseVersion Uses

func WriteDatabaseVersion(db ethdb.KeyValueWriter, version uint64)

WriteDatabaseVersion stores the version number of the database

func WriteFastTrieProgress Uses

func WriteFastTrieProgress(db ethdb.KeyValueWriter, count uint64)

WriteFastTrieProgress stores the fast sync trie process counter to support retrieving it across restarts.

func WriteFastTxLookupLimit Uses

func WriteFastTxLookupLimit(db ethdb.KeyValueWriter, number uint64)

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

func WriteHeadBlockHash Uses

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

WriteHeadBlockHash stores the head block's hash.

func WriteHeadFastBlockHash Uses

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

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

func WriteHeadHeaderHash Uses

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

WriteHeadHeaderHash stores the hash of the current canonical head header.

func WriteHeader Uses

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 Uses

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

WriteHeaderNumber stores the hash->number mapping.

func WriteLastPivotNumber Uses

func WriteLastPivotNumber(db ethdb.KeyValueWriter, pivot uint64)

WriteLastPivotNumber stores the number of the last pivot block.

func WritePreimages Uses

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

WritePreimages writes the provided set of preimages to the database.

func WriteReceipts Uses

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

WriteReceipts stores all the transaction receipts belonging to a block.

func WriteSnapshotJournal Uses

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

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

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

func WriteStorageSnapshot Uses

func WriteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash, entry []byte)

WriteStorageSnapshot stores the snapshot entry of an storage trie leaf.

func WriteTd Uses

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

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

func WriteTrieNode Uses

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

WriteTrieNode writes the provided trie node database.

func WriteTxIndexTail Uses

func WriteTxIndexTail(db ethdb.KeyValueWriter, number uint64)

WriteTxIndexTail stores the number of oldest indexed block into database.

func WriteTxLookupEntries Uses

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 Uses

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.

type LegacyTxLookupEntry Uses

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

LegacyTxLookupEntry is the legacy TxLookupEntry definition with some unnecessary fields.

Package rawdb imports 29 packages (graph) and is imported by 641 packages. Updated 2020-10-20. Refresh now. Tools for package owners.