Documentation ¶
Overview ¶
Package rawdb contains a collection of low level database accessors.
Index ¶
- Constants
- Variables
- func DeleteAccountSnapshot(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteAllHeadsHashes(db ethdb.KeyValueWriter)
- func DeleteAllPbBodyKeys(db ethdb.KeyValueWriter)
- func DeleteBadBlocks(db ethdb.KeyValueWriter)
- func DeleteBadHashesList(db ethdb.KeyValueWriter)
- func DeleteBestPhKey(db ethdb.KeyValueWriter)
- func DeleteBlock(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteBlockWithoutNumber(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteBloom(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteBloombits(db ethdb.Database, bit uint, from uint64, to uint64)
- func DeleteBody(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteCanonicalHash(db ethdb.KeyValueWriter, number uint64)
- func DeleteCode(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteEtxSet(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteHeader(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteHeaderNumber(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteInboundEtxs(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteManifest(db ethdb.KeyValueWriter, hash common.Hash)
- func DeletePbCacheBody(db ethdb.KeyValueWriter, hash common.Hash)
- func DeletePendingEtxs(db ethdb.KeyValueWriter, hash common.Hash)
- func DeletePendingEtxsRollup(db ethdb.KeyValueWriter, hash common.Hash)
- func DeletePendingHeader(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func DeleteSnapshotDisabled(db ethdb.KeyValueWriter)
- func DeleteSnapshotGenerator(db ethdb.KeyValueWriter)
- func DeleteSnapshotJournal(db ethdb.KeyValueWriter)
- func DeleteSnapshotRecoveryNumber(db ethdb.KeyValueWriter)
- func DeleteSnapshotRoot(db ethdb.KeyValueWriter)
- func DeleteSnapshotSyncStatus(db ethdb.KeyValueWriter)
- func DeleteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash)
- func DeleteTermini(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteTrieNode(db ethdb.KeyValueWriter, hash common.Hash)
- func DeleteTxLookupEntries(db ethdb.KeyValueWriter, hashes []common.Hash)
- func DeleteTxLookupEntry(db ethdb.KeyValueWriter, hash common.Hash)
- func FindCommonAncestor(db ethdb.Reader, a, b *types.Header) *types.Header
- func HasBody(db ethdb.Reader, hash common.Hash, number uint64) bool
- func HasHeader(db ethdb.Reader, hash common.Hash, number uint64) bool
- func HasReceipts(db ethdb.Reader, hash common.Hash, number uint64) bool
- func IndexTransactions(db ethdb.Database, from uint64, to uint64, interrupt chan struct{})
- func InitDatabaseFromFreezer(db ethdb.Database)
- func InspectDatabase(db ethdb.Database, keyPrefix, keyStart []byte) error
- func IsCodeKey(key []byte) (bool, []byte)
- func IterateStorageSnapshots(db ethdb.Iteratee, accountHash common.Hash) ethdb.Iterator
- func NewDatabase(db ethdb.KeyValueStore) ethdb.Database
- func NewDatabaseWithFreezer(db ethdb.KeyValueStore, freezer string, namespace string, readonly bool) (ethdb.Database, error)
- func NewFreezerTable(path, name string, disableSnappy bool) (*freezerTable, error)
- func NewLevelDBDatabase(file string, cache int, handles int, namespace string, readonly bool) (ethdb.Database, error)
- func NewMemoryDatabase() ethdb.Database
- func NewMemoryDatabaseWithCap(size int) ethdb.Database
- func NewPebbleDBDatabase(file string, cache int, handles int, namespace string, readonly bool) (ethdb.Database, error)
- func NewTable(db ethdb.Database, prefix string) ethdb.Database
- func Open(o OpenOptions) (ethdb.Database, error)
- func PopUncleanShutdownMarker(db ethdb.KeyValueStore)
- func PushUncleanShutdownMarker(db ethdb.KeyValueStore) ([]uint64, uint64, error)
- func ReadAccountSnapshot(db ethdb.KeyValueReader, hash common.Hash) []byte
- func ReadAllBadBlocks(db ethdb.Reader) []*types.Block
- func ReadAllCanonicalHashes(db ethdb.Iteratee, from uint64, to uint64, limit int) ([]uint64, []common.Hash)
- func ReadAllHashes(db ethdb.Iteratee, number uint64) []common.Hash
- func ReadBadBlock(db ethdb.Reader, hash common.Hash) *types.Block
- func ReadBadHashesList(db ethdb.Reader) types.BlockManifest
- func ReadBestPhKey(db ethdb.Reader) common.Hash
- func ReadBlock(db ethdb.Reader, hash common.Hash, number uint64) *types.Block
- func ReadBloom(db ethdb.Reader, hash common.Hash) *types.Bloom
- func ReadBloomBits(db ethdb.KeyValueReader, bit uint, section uint64, head common.Hash) ([]byte, error)
- func ReadBloomRLP(db ethdb.Reader, hash common.Hash) rlp.RawValue
- func ReadBody(db ethdb.Reader, hash common.Hash, number uint64) *types.Body
- func ReadBodyRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue
- func ReadCanonicalBodyRLP(db ethdb.Reader, number uint64) rlp.RawValue
- func ReadCanonicalHash(db ethdb.Reader, number uint64) common.Hash
- func ReadChainConfig(db ethdb.KeyValueReader, hash common.Hash) *params.ChainConfig
- func ReadCode(db ethdb.KeyValueReader, hash common.Hash) []byte
- func ReadCodeWithPrefix(db ethdb.KeyValueReader, hash common.Hash) []byte
- func ReadDatabaseVersion(db ethdb.KeyValueReader) *uint64
- func ReadEtxSet(db ethdb.Reader, hash common.Hash, number uint64) types.EtxSet
- func ReadEtxSetRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue
- func ReadFastTrieProgress(db ethdb.KeyValueReader) uint64
- func ReadFastTxLookupLimit(db ethdb.KeyValueReader) *uint64
- func ReadHeadBlock(db ethdb.Reader) *types.Block
- func ReadHeadBlockHash(db ethdb.KeyValueReader) common.Hash
- func ReadHeadHeader(db ethdb.Reader) *types.Header
- func ReadHeadHeaderHash(db ethdb.KeyValueReader) common.Hash
- func ReadHeader(db ethdb.Reader, hash common.Hash, number uint64) *types.Header
- func ReadHeaderNumber(db ethdb.KeyValueReader, hash common.Hash) *uint64
- func ReadHeaderRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue
- func ReadHeadsHashes(db ethdb.Reader) []common.Hash
- func ReadInboundEtxs(db ethdb.Reader, hash common.Hash) types.Transactions
- func ReadLastPivotNumber(db ethdb.KeyValueReader) *uint64
- func ReadLogs(db ethdb.Reader, hash common.Hash, number uint64) [][]*types.Log
- func ReadManifest(db ethdb.Reader, hash common.Hash) types.BlockManifest
- func ReadPbBodyKeys(db ethdb.Reader) []common.Hash
- func ReadPbCacheBody(db ethdb.Reader, hash common.Hash) *types.Body
- func ReadPendingEtxs(db ethdb.Reader, hash common.Hash) *types.PendingEtxs
- func ReadPendingEtxsRLP(db ethdb.Reader, hash common.Hash) rlp.RawValue
- func ReadPendingEtxsRollup(db ethdb.Reader, hash common.Hash) *types.PendingEtxsRollup
- func ReadPendingHeader(db ethdb.Reader, hash common.Hash) *types.PendingHeader
- func ReadPreimage(db ethdb.KeyValueReader, hash common.Hash) []byte
- func ReadRawReceipts(db ethdb.Reader, hash common.Hash, number uint64) types.Receipts
- func ReadReceipt(db ethdb.Reader, hash common.Hash, config *params.ChainConfig) (*types.Receipt, common.Hash, uint64, uint64)
- func ReadReceipts(db ethdb.Reader, hash common.Hash, number uint64, config *params.ChainConfig) types.Receipts
- func ReadReceiptsRLP(db ethdb.Reader, hash common.Hash, number uint64) rlp.RawValue
- func ReadSnapshotDisabled(db ethdb.KeyValueReader) bool
- func ReadSnapshotGenerator(db ethdb.KeyValueReader) []byte
- func ReadSnapshotJournal(db ethdb.KeyValueReader) []byte
- func ReadSnapshotRecoveryNumber(db ethdb.KeyValueReader) *uint64
- func ReadSnapshotRoot(db ethdb.KeyValueReader) common.Hash
- func ReadSnapshotSyncStatus(db ethdb.KeyValueReader) []byte
- func ReadStorageSnapshot(db ethdb.KeyValueReader, accountHash, storageHash common.Hash) []byte
- func ReadTermini(db ethdb.Reader, hash common.Hash) *types.Termini
- func ReadTransaction(db ethdb.Reader, hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)
- func ReadTrieNode(db ethdb.KeyValueReader, hash common.Hash) []byte
- func ReadTxIndexTail(db ethdb.KeyValueReader) *uint64
- func ReadTxLookupEntry(db ethdb.Reader, hash common.Hash) *uint64
- func UnindexTransactions(db ethdb.Database, from uint64, to uint64, interrupt chan struct{})
- func WriteAccountSnapshot(db ethdb.KeyValueWriter, hash common.Hash, entry []byte)
- func WriteBadBlock(db ethdb.KeyValueStore, block *types.Block)
- func WriteBadHashesList(db ethdb.KeyValueWriter, badHashes []common.Hash)
- func WriteBestPhKey(db ethdb.KeyValueWriter, bestPhKey common.Hash)
- func WriteBlock(db ethdb.KeyValueWriter, block *types.Block)
- func WriteBloom(db ethdb.KeyValueWriter, hash common.Hash, bloom types.Bloom)
- func WriteBloomBits(db ethdb.KeyValueWriter, bit uint, section uint64, head common.Hash, ...)
- func WriteBloomRLP(db ethdb.KeyValueWriter, hash common.Hash, rlp rlp.RawValue)
- func WriteBody(db ethdb.KeyValueWriter, hash common.Hash, number uint64, body *types.Body)
- func WriteBodyRLP(db ethdb.KeyValueWriter, hash common.Hash, number uint64, rlp rlp.RawValue)
- func WriteCanonicalHash(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func WriteChainConfig(db ethdb.KeyValueWriter, hash common.Hash, cfg *params.ChainConfig)
- func WriteCode(db ethdb.KeyValueWriter, hash common.Hash, code []byte)
- func WriteDatabaseVersion(db ethdb.KeyValueWriter, version uint64)
- func WriteEtxSet(db ethdb.KeyValueWriter, hash common.Hash, number uint64, etxSet types.EtxSet)
- func WriteEtxSetRLP(db ethdb.KeyValueWriter, hash common.Hash, number uint64, rlp rlp.RawValue)
- func WriteFastTrieProgress(db ethdb.KeyValueWriter, count uint64)
- func WriteFastTxLookupLimit(db ethdb.KeyValueWriter, number uint64)
- func WriteHeadBlockHash(db ethdb.KeyValueWriter, hash common.Hash)
- func WriteHeadHeaderHash(db ethdb.KeyValueWriter, hash common.Hash)
- func WriteHeader(db ethdb.KeyValueWriter, header *types.Header)
- func WriteHeaderNumber(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
- func WriteHeadsHashes(db ethdb.KeyValueWriter, hashes []common.Hash)
- func WriteInboundEtxs(db ethdb.KeyValueWriter, hash common.Hash, inboundEtxs types.Transactions)
- func WriteLastPivotNumber(db ethdb.KeyValueWriter, pivot uint64)
- func WriteManifest(db ethdb.KeyValueWriter, hash common.Hash, manifest types.BlockManifest)
- func WritePbBodyKeys(db ethdb.KeyValueWriter, hashes []common.Hash)
- func WritePbCacheBody(db ethdb.KeyValueWriter, hash common.Hash, body *types.Body)
- func WritePendingEtxs(db ethdb.KeyValueWriter, pendingEtxs types.PendingEtxs)
- func WritePendingEtxsRLP(db ethdb.KeyValueWriter, hash common.Hash, rlp rlp.RawValue)
- func WritePendingEtxsRollup(db ethdb.KeyValueWriter, pendingEtxsRollup types.PendingEtxsRollup)
- func WritePendingHeader(db ethdb.KeyValueWriter, hash common.Hash, pendingHeader types.PendingHeader)
- func WritePreimages(db ethdb.KeyValueWriter, preimages map[common.Hash][]byte)
- func WriteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64, ...)
- func WriteSnapshotDisabled(db ethdb.KeyValueWriter)
- func WriteSnapshotGenerator(db ethdb.KeyValueWriter, generator []byte)
- func WriteSnapshotJournal(db ethdb.KeyValueWriter, journal []byte)
- func WriteSnapshotRecoveryNumber(db ethdb.KeyValueWriter, number uint64)
- func WriteSnapshotRoot(db ethdb.KeyValueWriter, root common.Hash)
- func WriteSnapshotSyncStatus(db ethdb.KeyValueWriter, status []byte)
- func WriteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash, entry []byte)
- func WriteTermini(db ethdb.KeyValueWriter, index common.Hash, hashes types.Termini)
- func WriteTrieNode(db ethdb.KeyValueWriter, hash common.Hash, node []byte)
- func WriteTxIndexTail(db ethdb.KeyValueWriter, number uint64)
- func WriteTxLookupEntries(db ethdb.KeyValueWriter, number uint64, hashes []common.Hash)
- func WriteTxLookupEntriesByBlock(db ethdb.KeyValueWriter, block *types.Block)
- type EtxSetEntry
- type LegacyTxLookupEntry
- type OpenOptions
Constants ¶
const PebbleEnabled = true
Pebble is unsuported on 32bit architecture
Variables ¶
var ( SnapshotAccountPrefix = []byte("a") // SnapshotAccountPrefix + account hash -> account trie value SnapshotStoragePrefix = []byte("o") // SnapshotStoragePrefix + account hash + storage hash -> storage trie value CodePrefix = []byte("c") // CodePrefix + code hash -> account code // 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.
var FreezerNoSnappy = map[string]bool{ // contains filtered or unexported fields }
FreezerNoSnappy configures whether compression is disabled for the ancient-tables. Hashes and difficulties don't compress well.
Functions ¶
func DeleteAccountSnapshot ¶
func DeleteAccountSnapshot(db ethdb.KeyValueWriter, hash common.Hash)
DeleteAccountSnapshot removes the snapshot entry of an account trie leaf.
func DeleteAllHeadsHashes ¶
func DeleteAllHeadsHashes(db ethdb.KeyValueWriter)
DeleteAllHeadsHashes writes the heads hashes of the blockchain.
func DeleteAllPbBodyKeys ¶
func DeleteAllPbBodyKeys(db ethdb.KeyValueWriter)
DeleteAllPbBodyKeys delete the pendingHeaderBody keys to the db
func DeleteBadBlocks ¶
func DeleteBadBlocks(db ethdb.KeyValueWriter)
DeleteBadBlocks deletes all the bad blocks from the database
func DeleteBadHashesList ¶
func DeleteBadHashesList(db ethdb.KeyValueWriter)
DeleteBadHashesList removes badHashesList from the database
func DeleteBestPhKey ¶
func DeleteBestPhKey(db ethdb.KeyValueWriter)
DeleteBestPhKey delete the bestPhKey of the blockchain
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 DeleteBloom ¶
func DeleteBloom(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteBloom removes all bloom data associated with a block.
func DeleteBloombits ¶
DeleteBloombits removes all compressed bloom bits vector belonging to the given section range and bit index.
func DeleteBody ¶
func DeleteBody(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteBody removes all block body data associated with a hash.
func DeleteCanonicalHash ¶
func DeleteCanonicalHash(db ethdb.KeyValueWriter, number uint64)
DeleteCanonicalHash removes the number to hash canonical mapping.
func DeleteCode ¶
func DeleteCode(db ethdb.KeyValueWriter, hash common.Hash)
DeleteCode deletes the specified contract code from the database.
func DeleteEtxSet ¶
func DeleteEtxSet(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteEtxSet removes all EtxSet data associated with a block.
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 DeleteInboundEtxs ¶
func DeleteInboundEtxs(db ethdb.KeyValueWriter, hash common.Hash)
DeleteInboundEtxs deletes the inbound etxs from the database
func DeleteManifest ¶
func DeleteManifest(db ethdb.KeyValueWriter, hash common.Hash)
DeleteManifest removes manifest data associated with a block.
func DeletePbCacheBody ¶
func DeletePbCacheBody(db ethdb.KeyValueWriter, hash common.Hash)
DeletePbCacheBody removes all block body data associated with a hash.
func DeletePendingEtxs ¶
func DeletePendingEtxs(db ethdb.KeyValueWriter, hash common.Hash)
DeletePendingEtxs removes all pending ETX data associated with a block.
func DeletePendingEtxsRollup ¶
func DeletePendingEtxsRollup(db ethdb.KeyValueWriter, hash common.Hash)
DeletePendingEtxsRollup removes all pending ETX rollup data associated with a block.
func DeletePendingHeader ¶
func DeletePendingHeader(db ethdb.KeyValueWriter, hash common.Hash)
DeletePendingHeader deletes the pending header stored for the header hash.
func DeleteReceipts ¶
func DeleteReceipts(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
DeleteReceipts removes all receipt data associated with a block hash.
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 DeleteSnapshotSyncStatus ¶
func DeleteSnapshotSyncStatus(db ethdb.KeyValueWriter)
DeleteSnapshotSyncStatus deletes the serialized sync status saved at the last shutdown
func DeleteStorageSnapshot ¶
func DeleteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash)
DeleteStorageSnapshot removes the snapshot entry of an storage trie leaf.
func DeleteTermini ¶
func DeleteTermini(db ethdb.KeyValueWriter, hash common.Hash)
DeleteTermini writes the heads hashes of the blockchain.
func DeleteTrieNode ¶
func DeleteTrieNode(db ethdb.KeyValueWriter, hash common.Hash)
DeleteTrieNode deletes the specified trie node from the database.
func DeleteTxLookupEntries ¶
func DeleteTxLookupEntries(db ethdb.KeyValueWriter, hashes []common.Hash)
DeleteTxLookupEntries removes all transaction lookups for a given block.
func DeleteTxLookupEntry ¶
func DeleteTxLookupEntry(db ethdb.KeyValueWriter, hash common.Hash)
DeleteTxLookupEntry removes all transaction data associated with a hash.
func FindCommonAncestor ¶
FindCommonAncestor returns the last common ancestor of two block headers
func HasReceipts ¶
HasReceipts verifies the existence of all the transaction receipts belonging to a block.
func IndexTransactions ¶
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 ¶
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 ¶
InspectDatabase traverses the entire database and checks the size of all different categories of data.
func IsCodeKey ¶
IsCodeKey reports whether the given byte slice is the key of contract code, if so return the raw code hash as well.
func IterateStorageSnapshots ¶
IterateStorageSnapshots returns an iterator for walking the entire storage space of a specific account.
func NewDatabase ¶
func NewDatabase(db ethdb.KeyValueStore) ethdb.Database
NewDatabase creates a high level database on top of a given key-value data store without a freezer moving immutable chain segments into cold storage.
func NewDatabaseWithFreezer ¶
func NewDatabaseWithFreezer(db ethdb.KeyValueStore, freezer string, namespace string, readonly bool) (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 NewFreezerTable ¶
NewFreezerTable opens the given path as a freezer table.
func NewLevelDBDatabase ¶
func NewLevelDBDatabase(file string, cache int, handles int, namespace string, readonly bool) (ethdb.Database, error)
NewLevelDBDatabase creates a persistent key-value database without a freezer moving immutable chain segments into cold storage.
func NewMemoryDatabase ¶
NewMemoryDatabase creates an ephemeral in-memory key-value database without a freezer moving immutable chain segments into cold storage.
func NewMemoryDatabaseWithCap ¶
NewMemoryDatabaseWithCap creates an ephemeral in-memory key-value database with an initial starting capacity, but without a freezer moving immutable chain segments into cold storage.
func 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 Open ¶
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 PopUncleanShutdownMarker ¶
func PopUncleanShutdownMarker(db ethdb.KeyValueStore)
PopUncleanShutdownMarker removes the last unclean shutdown marker
func PushUncleanShutdownMarker ¶
func PushUncleanShutdownMarker(db ethdb.KeyValueStore) ([]uint64, uint64, error)
PushUncleanShutdownMarker appends a new unclean shutdown marker and returns the previous data - a list of timestamps - a count of how many old unclean-shutdowns have been discarded
func ReadAccountSnapshot ¶
func ReadAccountSnapshot(db ethdb.KeyValueReader, hash common.Hash) []byte
ReadAccountSnapshot retrieves the snapshot entry of an account trie leaf.
func ReadAllBadBlocks ¶
ReadAllBadBlocks retrieves all the bad blocks in the database. All returned blocks are sorted in reverse order by number.
func ReadAllCanonicalHashes ¶
func ReadAllCanonicalHashes(db ethdb.Iteratee, from uint64, to uint64, limit int) ([]uint64, []common.Hash)
ReadAllCanonicalHashes retrieves all canonical number and hash mappings at the certain chain range. If the accumulated entries reaches the given threshold, abort the iteration and return the semi-finish result.
func ReadAllHashes ¶
ReadAllHashes retrieves all the hashes assigned to blocks at a certain heights, both canonical and reorged forks included.
func ReadBadBlock ¶
ReadBadBlock retrieves the bad block with the corresponding block hash.
func ReadBadHashesList ¶
func ReadBadHashesList(db ethdb.Reader) types.BlockManifest
ReadBadHashesList retreives the bad hashes corresponding to the recent fork
func ReadBestPhKey ¶
ReadBestPhKey retreive's the bestPhKey of the blockchain
func ReadBlock ¶
ReadBlock retrieves an entire block corresponding to the hash, assembling it back from the stored header and body. If either the header or body could not be retrieved nil is returned.
Note, due to concurrent download of header and block body the header and thus canonical hash can be stored in the database but the body data not (yet).
func ReadBloomBits ¶
func ReadBloomBits(db ethdb.KeyValueReader, bit uint, section uint64, head common.Hash) ([]byte, error)
ReadBloomBits retrieves the compressed bloom bit vector belonging to the given section and bit index from the.
func ReadBloomRLP ¶
ReadBloomRLP retrieves the bloom for the given block, in RLP encoding
func ReadBodyRLP ¶
ReadBodyRLP retrieves the block body (transactions and uncles) in RLP encoding.
func ReadCanonicalBodyRLP ¶
ReadCanonicalBodyRLP retrieves the block body (transactions and uncles) for the canonical block at number, in RLP encoding.
func ReadCanonicalHash ¶
ReadCanonicalHash retrieves the hash assigned to a canonical block number.
func ReadChainConfig ¶
func ReadChainConfig(db ethdb.KeyValueReader, hash common.Hash) *params.ChainConfig
ReadChainConfig retrieves the consensus settings based on the given genesis hash.
func ReadCode ¶
func ReadCode(db ethdb.KeyValueReader, hash common.Hash) []byte
ReadCode retrieves the contract code of the provided code hash.
func ReadCodeWithPrefix ¶
func ReadCodeWithPrefix(db ethdb.KeyValueReader, hash common.Hash) []byte
ReadCodeWithPrefix retrieves the contract code of the provided code hash. The main difference between this function and ReadCode is this function will only check the existence with latest scheme(with prefix).
func ReadDatabaseVersion ¶
func ReadDatabaseVersion(db ethdb.KeyValueReader) *uint64
ReadDatabaseVersion retrieves the version number of the database.
func ReadEtxSet ¶
ReadEtxSet retreives the EtxSet corresponding to a given block
func ReadEtxSetRLP ¶
ReadEtxSetRLP retrieves the EtxSet corresponding to a given block, in RLP encoding.
func ReadFastTrieProgress ¶
func ReadFastTrieProgress(db ethdb.KeyValueReader) uint64
ReadFastTrieProgress retrieves the number of tries nodes fast synced to allow reporting correct numbers across restarts.
func ReadFastTxLookupLimit ¶
func ReadFastTxLookupLimit(db ethdb.KeyValueReader) *uint64
ReadFastTxLookupLimit retrieves the tx lookup limit used in fast sync.
func ReadHeadBlock ¶
ReadHeadBlock returns the current canonical head block.
func ReadHeadBlockHash ¶
func ReadHeadBlockHash(db ethdb.KeyValueReader) common.Hash
ReadHeadBlockHash retrieves the hash of the current canonical head block.
func ReadHeadHeader ¶
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 ¶
ReadHeader retrieves the block header corresponding to the hash.
func ReadHeaderNumber ¶
func ReadHeaderNumber(db ethdb.KeyValueReader, hash common.Hash) *uint64
ReadHeaderNumber returns the header number assigned to a hash.
func ReadHeaderRLP ¶
ReadHeaderRLP retrieves a block header in its raw RLP database encoding.
func ReadHeadsHashes ¶
ReadHeadsHashes retreive's the heads hashes of the blockchain.
func ReadInboundEtxs ¶
ReadInboundEtxs reads the inbound etxs from the database
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 ReadLogs ¶
ReadLogs retrieves the logs for all transactions in a block. The log fields are populated with metadata. In case the receipts or the block body are not found, a nil is returned.
func ReadManifest ¶
ReadManifest retreives the manifest corresponding to a given block
func ReadPbBodyKeys ¶
ReadPbBodyKeys retreive's the phBodyKeys of the worker
func ReadPbCacheBody ¶
ReadPbCacheBody retrieves the block body corresponding to the hash.
func ReadPendingEtxs ¶
ReadPendingEtxs retreives the pending ETXs corresponding to a given block
func ReadPendingEtxsRLP ¶
ReadPendingEtxsRLP retrieves the set of pending ETXs for the given block, in RLP encoding
func ReadPendingEtxsRollup ¶
ReadPendingEtxsRollup retreives the pending ETXs rollup corresponding to a given block
func ReadPendingHeader ¶
ReadPendingHeader retreive's the pending header stored in hash.
func ReadPreimage ¶
func ReadPreimage(db ethdb.KeyValueReader, hash common.Hash) []byte
ReadPreimage retrieves a single preimage of the provided hash.
func ReadRawReceipts ¶
ReadRawReceipts retrieves all the transaction receipts belonging to a block. The receipt metadata fields are not guaranteed to be populated, so they should not be used. Use ReadReceipts instead if the metadata is needed.
func ReadReceipt ¶
func ReadReceipt(db ethdb.Reader, hash common.Hash, config *params.ChainConfig) (*types.Receipt, common.Hash, uint64, uint64)
ReadReceipt retrieves a specific transaction receipt from the database, along with its added positional metadata.
func ReadReceipts ¶
func ReadReceipts(db ethdb.Reader, hash common.Hash, number uint64, config *params.ChainConfig) types.Receipts
ReadReceipts retrieves all the transaction receipts belonging to a block, including its 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 ¶
ReadReceiptsRLP retrieves all the transaction receipts belonging to a block in RLP encoding.
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 ReadStorageSnapshot ¶
func ReadStorageSnapshot(db ethdb.KeyValueReader, accountHash, storageHash common.Hash) []byte
ReadStorageSnapshot retrieves the snapshot entry of an storage trie leaf.
func ReadTermini ¶
ReadHeadsHashes retreive's the heads hashes of the blockchain.
func ReadTransaction ¶
func ReadTransaction(db ethdb.Reader, hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)
ReadTransaction retrieves a specific transaction from the database, along with its added positional metadata.
func ReadTrieNode ¶
func ReadTrieNode(db ethdb.KeyValueReader, hash common.Hash) []byte
ReadTrieNode retrieves the trie node of the provided hash.
func ReadTxIndexTail ¶
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 ¶
ReadTxLookupEntry retrieves the positional metadata associated with a transaction hash to allow retrieving the transaction or receipt by hash.
func UnindexTransactions ¶
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 ¶
func WriteAccountSnapshot(db ethdb.KeyValueWriter, hash common.Hash, entry []byte)
WriteAccountSnapshot stores the snapshot entry of an account trie leaf.
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.
func WriteBadHashesList ¶
func WriteBadHashesList(db ethdb.KeyValueWriter, badHashes []common.Hash)
WriteBadHashesList stores the bad hashes corresponding to the recent fork
func WriteBestPhKey ¶
func WriteBestPhKey(db ethdb.KeyValueWriter, bestPhKey common.Hash)
WriteBestPhKey writes the bestPhKey of the blockchain
func WriteBlock ¶
func WriteBlock(db ethdb.KeyValueWriter, block *types.Block)
WriteBlock serializes a block into the database, header and body separately.
func WriteBloom ¶
WriteBloom stores the bloom corresponding to a given block
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 WriteBloomRLP ¶
WriteBloomRLP stores the bloom corresponding to a given block, in RLP encoding.
func WriteBodyRLP ¶
WriteBodyRLP stores an RLP encoded block body into the database.
func WriteCanonicalHash ¶
func WriteCanonicalHash(db ethdb.KeyValueWriter, hash common.Hash, number uint64)
WriteCanonicalHash stores the hash assigned to a canonical block number.
func WriteChainConfig ¶
func WriteChainConfig(db ethdb.KeyValueWriter, hash common.Hash, cfg *params.ChainConfig)
WriteChainConfig writes the chain config settings to the database.
func WriteCode ¶
func WriteCode(db ethdb.KeyValueWriter, hash common.Hash, code []byte)
WriteCode writes the provided contract code database.
func WriteDatabaseVersion ¶
func WriteDatabaseVersion(db ethdb.KeyValueWriter, version uint64)
WriteDatabaseVersion stores the version number of the database
func WriteEtxSet ¶
WriteEtxSet stores the EtxSet corresponding to a given block
func WriteEtxSetRLP ¶
WriteEtxSetRLP stores the EtxSet corresponding to a given block, in RLP encoding.
func WriteFastTrieProgress ¶
func WriteFastTrieProgress(db ethdb.KeyValueWriter, count uint64)
WriteFastTrieProgress stores the fast sync trie process counter to support retrieving it across restarts.
func WriteFastTxLookupLimit ¶
func WriteFastTxLookupLimit(db ethdb.KeyValueWriter, number uint64)
WriteFastTxLookupLimit stores the txlookup limit used in fast sync into 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 WriteHeadsHashes ¶
func WriteHeadsHashes(db ethdb.KeyValueWriter, hashes []common.Hash)
WriteHeadsHashes writes the heads hashes of the blockchain.
func WriteInboundEtxs ¶
func WriteInboundEtxs(db ethdb.KeyValueWriter, hash common.Hash, inboundEtxs types.Transactions)
WriteInboundEtxs stores the inbound etxs for a given dom block hashes
func WriteLastPivotNumber ¶
func WriteLastPivotNumber(db ethdb.KeyValueWriter, pivot uint64)
WriteLastPivotNumber stores the number of the last pivot block.
func WriteManifest ¶
func WriteManifest(db ethdb.KeyValueWriter, hash common.Hash, manifest types.BlockManifest)
WriteManifest stores the manifest corresponding to a given block
func WritePbBodyKeys ¶
func WritePbBodyKeys(db ethdb.KeyValueWriter, hashes []common.Hash)
WritePbBodyKeys writes the workers pendingHeaderBody keys to the db
func WritePbCacheBody ¶
WritePbCacheBody stores a block body into the database.
func WritePendingEtxs ¶
func WritePendingEtxs(db ethdb.KeyValueWriter, pendingEtxs types.PendingEtxs)
WritePendingEtxs stores the pending ETXs corresponding to a given block
func WritePendingEtxsRLP ¶
WritePendingEtxsRLP stores the pending ETXs corresponding to a given block, in RLP encoding.
func WritePendingEtxsRollup ¶
func WritePendingEtxsRollup(db ethdb.KeyValueWriter, pendingEtxsRollup types.PendingEtxsRollup)
WritePendingEtxsRollup stores the pending ETXs rollup corresponding to a given block
func WritePendingHeader ¶
func WritePendingHeader(db ethdb.KeyValueWriter, hash common.Hash, pendingHeader types.PendingHeader)
WritePendingHeader writes the pending header of the terminus hash.
func WritePreimages ¶
func WritePreimages(db ethdb.KeyValueWriter, preimages map[common.Hash][]byte)
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)
WriteReceipts stores all the transaction receipts belonging to a block.
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 WriteTermini ¶
WriteTermini writes the heads hashes of the blockchain.
func WriteTrieNode ¶
func WriteTrieNode(db ethdb.KeyValueWriter, hash common.Hash, node []byte)
WriteTrieNode writes the provided trie node database.
func WriteTxIndexTail ¶
func WriteTxIndexTail(db ethdb.KeyValueWriter, number uint64)
WriteTxIndexTail stores the number of oldest indexed block into database.
func WriteTxLookupEntries ¶
func WriteTxLookupEntries(db ethdb.KeyValueWriter, number uint64, hashes []common.Hash)
WriteTxLookupEntries is identical to WriteTxLookupEntry, but it works on a list of hashes
func WriteTxLookupEntriesByBlock ¶
func WriteTxLookupEntriesByBlock(db ethdb.KeyValueWriter, block *types.Block)
WriteTxLookupEntriesByBlock stores a positional metadata for every transaction from a block, enabling hash based transaction and receipt lookups.
Types ¶
type EtxSetEntry ¶
type EtxSetEntry struct { EtxHash common.Hash EtxHeight uint64 Etx types.Transaction }
type LegacyTxLookupEntry ¶
LegacyTxLookupEntry is the legacy TxLookupEntry definition with some unnecessary fields.
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.