rawdb

package
v1.0.2 Latest Latest
Warning

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

 Go to latest Published: Jan 15, 2024 License: GPL-3.0 Imports: 32 Imported by: 0

Documentation

Overview

Package rawdb contains a collection of low level database accessors.

Index

Constants

This section is empty.

Variables

View Source 
var (

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

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

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

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

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

func DeleteBadBlocks(db ethdb.KeyValueWriter)

DeleteBadBlocks deletes all the bad blocks from the database

func DeleteBatchChunkRanges 

func DeleteBatchChunkRanges(db ethdb.KeyValueWriter, batchIndex uint64)

DeleteBatchChunkRanges removes the block ranges of all chunks associated with a specific batch from the database. Note: Only non-finalized batches can be reverted.

func DeleteBlock 

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

DeleteBlock removes all block data associated with a hash.

func DeleteBlockWithoutNumber 

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

DeleteBlockWithoutNumber removes all block data associated with a hash, except the hash to number mapping.

func DeleteBloombits 

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

DeleteBloombits removes all compressed bloom bits vector belonging to the given section range and bit index.

func DeleteBody 

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

DeleteBody removes all block body data associated with a hash.

func DeleteCanonicalHash 

func DeleteCanonicalHash(db ethdb.KeyValueWriter, number uint64)

DeleteCanonicalHash removes the number to hash canonical mapping.

func DeleteCode 

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

DeleteCode deletes the specified contract code from the database.

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

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

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

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 

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

FindCommonAncestor returns the last common ancestor of two block headers

func FirstQueueIndexNotInL2BlockKey 

func FirstQueueIndexNotInL2BlockKey(l2BlockHash common.Hash) []byte

FirstQueueIndexNotInL2BlockKey = firstQueueIndexNotInL2BlockPrefix + L2 block 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 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 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 IndexTransactions 

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 

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 

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

func L1MessageKey(queueIndex uint64) []byte

L1MessageKey = l1MessagePrefix + queueIndex (uint64 big endian)

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 

func NewFreezerTable(path, name string, disableSnappy bool) (*freezerTable, error)

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 NewLevelDBDatabaseWithFreezer 

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

NewLevelDBDatabaseWithFreezer creates a persistent key-value database with 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 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

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 

func ReadAllBadBlocks(db ethdb.Reader) []*types.Block

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 

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 ReadBadBlock 

func ReadBadBlock(db ethdb.Reader, hash common.Hash) *types.Block

ReadBadBlock retrieves the bad block with the corresponding block hash.

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 ReadBlockRowConsumption 

func ReadBlockRowConsumption(db ethdb.Reader, l2BlockHash common.Hash) *types.RowConsumption

ReadBlockRowConsumption retrieves the RowConsumption corresponding to the block hash.

func ReadBlockRowConsumptionRLP 

func ReadBlockRowConsumptionRLP(db ethdb.Reader, l2BlockHash common.Hash) rlp.RawValue

ReadBlockRowConsumption retrieves the RowConsumption in its raw RLP database encoding.

func ReadBloomBits 

func ReadBloomBits(db ethdb.KeyValueReader, bit uint, section uint64, head common.Hash) ([]byte, error)

ReadBloomBits retrieves the compressed bloom bit vector belonging to the given section and bit index from the.

func ReadBody 

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

ReadBody retrieves the block body corresponding to the hash.

func ReadBodyRLP 

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

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

func ReadCanonicalBodyRLP 

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 ReadDatabaseVersion 

func ReadDatabaseVersion(db ethdb.KeyValueReader) *uint64

ReadDatabaseVersion retrieves the version number of the database.

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 ReadFinalizedL2BlockNumber 

func ReadFinalizedL2BlockNumber(db ethdb.Reader) *uint64

ReadFinalizedL2BlockNumber fetches the highest finalized L2 block number from the database.

func ReadFirstQueueIndexNotInL2Block 

func ReadFirstQueueIndexNotInL2Block(db ethdb.Reader, l2BlockHash common.Hash) *uint64

ReadFirstQueueIndexNotInL2Block retrieves the queue index of the first message that is NOT included in the ledger up to and including the provided L2 block.

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) *types.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) *types.Header

ReadHeader retrieves the block header corresponding to the hash.

func ReadHeaderNumber 

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

ReadHeaderNumber returns the header number assigned to a hash.

func ReadHeaderRLP 

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

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

func ReadHighestSyncedQueueIndex 

func ReadHighestSyncedQueueIndex(db ethdb.Reader) uint64

ReadHighestSyncedQueueIndex retrieves the highest synced L1 message queue index.

func ReadL1Message 

func ReadL1Message(db ethdb.Reader, queueIndex uint64) *types.L1MessageTx

ReadL1Message retrieves the L1 message corresponding to the enqueue index.

func ReadL1MessageRLP 

func ReadL1MessageRLP(db ethdb.Reader, queueIndex uint64) rlp.RawValue

ReadL1MessageRLP retrieves an L1 message in its raw RLP database encoding.

func ReadL1MessagesFrom 

func ReadL1MessagesFrom(db ethdb.Database, startIndex, maxCount uint64) []types.L1MessageTx

ReadL1MessagesFrom retrieves up to `maxCount` L1 messages starting at `startIndex`.

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 

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. The log fields are populated with metadata. In case the receipts or the block body are not found, a nil is returned.

func ReadNumSkippedTransactions 

func ReadNumSkippedTransactions(db ethdb.Reader) uint64

ReadNumSkippedTransactions retrieves the number of skipped transactions.

func ReadPreimage 

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

ReadPreimage retrieves a single preimage of the provided hash.

func ReadRawReceipts 

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

ReadRawReceipts retrieves all the transaction receipts belonging to a block. The receipt metadata fields are not guaranteed to be populated, so they should not be used. Use ReadReceipts instead if the metadata is needed.

func ReadReceipt 

func ReadReceipt(db ethdb.Reader, hash common.Hash, config *params.ChainConfig) (*types.Receipt, common.Hash, uint64, uint64)

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

func ReadReceipts 

func ReadReceipts(db ethdb.Reader, hash common.Hash, number uint64, 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 

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 ReadRollupEventSyncedL1BlockNumber 

func ReadRollupEventSyncedL1BlockNumber(db ethdb.Reader) *uint64

ReadRollupEventSyncedL1BlockNumber fetches the highest synced L1 block number associated with rollup events from the database.

func ReadSkippedTransactionHash 

func ReadSkippedTransactionHash(db ethdb.Reader, index uint64) *common.Hash

ReadSkippedTransactionHash retrieves the hash of a skipped transaction by its index.

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 ReadSyncedL1BlockNumber 

func ReadSyncedL1BlockNumber(db ethdb.Reader) *uint64

ReadSyncedL1BlockNumber retrieves the highest synced L1 block number.

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

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 SetL1MessageLegacyPrefix 

func SetL1MessageLegacyPrefix()

Use the updated "L1" prefix on all new networks to avoid overlap with txLookupPrefix. Use the legacy "l1" prefix on Scroll Sepolia.

func SkippedTransactionHashKey 

func SkippedTransactionHashKey(index uint64) []byte

SkippedTransactionHashKey = skippedTransactionHashPrefix + index (uint64 big endian)

func SkippedTransactionKey 

func SkippedTransactionKey(txHash common.Hash) []byte

SkippedTransactionKey = skippedTransactionPrefix + tx hash

func UnindexTransactions 

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 

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

WriteAccountSnapshot stores the snapshot entry of an account trie leaf.

func WriteAncientBlocks 

func WriteAncientBlocks(db ethdb.AncientWriter, blocks []*types.Block, receipts []types.Receipts, td *big.Int) (int64, error)

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

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 WriteBatchChunkRanges 

func WriteBatchChunkRanges(db ethdb.KeyValueWriter, batchIndex uint64, chunkBlockRanges []*ChunkBlockRange)

WriteBatchChunkRanges writes the block ranges for each chunk within a batch to the database. It serializes the chunk ranges using RLP and stores them under a key derived from the batch index.

func WriteBlock 

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

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

func WriteBlockRowConsumption 

func WriteBlockRowConsumption(db ethdb.KeyValueWriter, l2BlockHash common.Hash, rc *types.RowConsumption)

WriteBlockRowConsumption writes a RowConsumption of the block to the database.

func WriteBloomBits 

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

WriteBloomBits stores the compressed bloom bits vector belonging to the given section and bit index.

func WriteBody 

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

WriteBody stores a block body into the database.

func WriteBodyRLP 

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

WriteBodyRLP stores an RLP encoded block body into the database.

func WriteCanonicalHash 

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

WriteCanonicalHash stores the hash assigned to a canonical block number.

func WriteChainConfig 

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

WriteChainConfig writes the chain config settings to the database.

func WriteCode 

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

func WriteFinalizedBatchMeta(db ethdb.KeyValueWriter, batchIndex uint64, finalizedBatchMeta *FinalizedBatchMeta)

WriteFinalizedBatchMeta stores the metadata of a finalized batch in the database.

func WriteFinalizedL2BlockNumber 

func WriteFinalizedL2BlockNumber(db ethdb.KeyValueWriter, l2BlockNumber uint64)

WriteFinalizedL2BlockNumber stores the highest finalized L2 block number in the database.

func WriteFirstQueueIndexNotInL2Block 

func WriteFirstQueueIndexNotInL2Block(db ethdb.KeyValueWriter, l2BlockHash common.Hash, queueIndex uint64)

WriteFirstQueueIndexNotInL2Block writes the queue index of the first message that is NOT included in the ledger up to and including the provided L2 block. The L2 block is identified by its block hash. If the L2 block contains zero L1 messages, this value MUST equal its parent's value.

func WriteHeadBlockHash 

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

WriteHeadBlockHash stores the head block's hash.

func WriteHeadFastBlockHash 

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

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

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 WriteHighestSyncedQueueIndex 

func WriteHighestSyncedQueueIndex(db ethdb.KeyValueWriter, queueIndex uint64)

WriteHighestSyncedQueueIndex writes the highest synced L1 message queue index to the database.

func WriteL1Message 

func WriteL1Message(db ethdb.KeyValueWriter, l1Msg types.L1MessageTx)

WriteL1Message writes an L1 message to the database. We assume that L1 messages are written to DB following their queue index order.

func WriteL1Messages 

func WriteL1Messages(db ethdb.KeyValueWriter, l1Msgs []types.L1MessageTx)

WriteL1Messages writes an array of L1 messages to the database. Note: pass a db of type `ethdb.Batcher` to batch writes in memory.

func WriteLastPivotNumber 

func WriteLastPivotNumber(db ethdb.KeyValueWriter, pivot uint64)

WriteLastPivotNumber stores the number of the last pivot block.

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 WriteRollupEventSyncedL1BlockNumber 

func WriteRollupEventSyncedL1BlockNumber(db ethdb.KeyValueWriter, l1BlockNumber uint64)

WriteRollupEventSyncedL1BlockNumber stores the latest synced L1 block number related to rollup events in the database.

func WriteSkippedTransaction 

func WriteSkippedTransaction(db ethdb.Database, tx *types.Transaction, traces *types.BlockTrace, reason string, blockNumber uint64, blockHash *common.Hash)

WriteSkippedTransaction writes a skipped transaction to the database and also updates the count and lookup index. Note: The lookup index and count will include duplicates if there are chain reorgs.

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 WriteSyncedL1BlockNumber 

func WriteSyncedL1BlockNumber(db ethdb.KeyValueWriter, L1BlockNumber uint64)

WriteSyncedL1BlockNumber writes the highest synced L1 block number to the database.

func WriteTd 

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 

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 ChunkBlockRange 

type ChunkBlockRange struct {
	StartBlockNumber uint64
	EndBlockNumber   uint64
}

ChunkBlockRange represents the range of blocks within a chunk.

func ReadBatchChunkRanges 

func ReadBatchChunkRanges(db ethdb.Reader, batchIndex uint64) []*ChunkBlockRange

ReadBatchChunkRanges retrieves the block ranges of all chunks associated with a specific batch from the database. It returns a list of ChunkBlockRange pointers, or nil if no chunk ranges are found for the given batch index.

type FinalizedBatchMeta 

type FinalizedBatchMeta struct {
	BatchHash            common.Hash
	TotalL1MessagePopped uint64 // total number of L1 messages popped before and in this batch.
	StateRoot            common.Hash
	WithdrawRoot         common.Hash
}

FinalizedBatchMeta holds metadata for finalized batches.

func ReadFinalizedBatchMeta 

func ReadFinalizedBatchMeta(db ethdb.Reader, batchIndex uint64) *FinalizedBatchMeta

ReadFinalizedBatchMeta fetches the metadata of a finalized batch from the database.

type L1MessageIterator 

type L1MessageIterator struct {
	// contains filtered or unexported fields
}

L1MessageIterator is a wrapper around ethdb.Iterator that allows us to iterate over L1 messages in the database. It implements an interface similar to ethdb.Iterator.

func IterateL1MessagesFrom 

func IterateL1MessagesFrom(db ethdb.Database, fromQueueIndex uint64) L1MessageIterator

IterateL1MessagesFrom creates an L1MessageIterator that iterates over all L1 message in the database starting at the provided enqueue index.

func (*L1MessageIterator) L1Message 

func (it *L1MessageIterator) L1Message() types.L1MessageTx

L1Message returns the current L1 message.

func (*L1MessageIterator) Next 

func (it *L1MessageIterator) Next() bool

Next moves the iterator to the next key/value pair. It returns false when the iterator is exhausted. TODO: Consider reading items in batches.

func (*L1MessageIterator) QueueIndex 

func (it *L1MessageIterator) QueueIndex() uint64

QueueIndex returns the enqueue index of the current L1 message.

func (*L1MessageIterator) Release 

func (it *L1MessageIterator) Release()

Release releases the associated resources.

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

ReadAllHashes retrieves all the hashes assigned to blocks at a certain heights, both canonical and reorged forks included. This method considers both limits to be _inclusive_.

type SkippedTransaction 

type SkippedTransaction struct {
	// Tx is the skipped transaction.
	// We store the tx itself because otherwise geth will discard it after skipping.
	Tx *types.Transaction

	// Reason is the skip reason.
	Reason string

	// BlockNumber is the number of the block in which this transaction was skipped.
	BlockNumber uint64

	// BlockHash is the hash of the block in which this transaction was skipped or nil.
	BlockHash *common.Hash
}

SkippedTransaction stores the transaction object, along with the skip reason and block context.

type SkippedTransactionIterator 

type SkippedTransactionIterator struct {
	// contains filtered or unexported fields
}

SkippedTransactionIterator is a wrapper around ethdb.Iterator that allows us to iterate over skipped transaction hashes in the database. It implements an interface similar to ethdb.Iterator.

func IterateSkippedTransactionsFrom 

func IterateSkippedTransactionsFrom(db ethdb.Database, index uint64) SkippedTransactionIterator

IterateSkippedTransactionsFrom creates a SkippedTransactionIterator that iterates over all skipped transaction hashes in the database starting at the provided index.

func (*SkippedTransactionIterator) Index 

func (it *SkippedTransactionIterator) Index() uint64

Index returns the index of the current skipped transaction hash.

func (*SkippedTransactionIterator) Next 

func (it *SkippedTransactionIterator) Next() bool

Next moves the iterator to the next key/value pair. It returns false when the iterator is exhausted. TODO: Consider reading items in batches.

func (*SkippedTransactionIterator) Release 

func (it *SkippedTransactionIterator) Release()

Release releases the associated resources.

func (*SkippedTransactionIterator) TransactionHash 

func (it *SkippedTransactionIterator) TransactionHash() common.Hash

TransactionHash returns the current skipped transaction hash.

type SkippedTransactionV2 

type SkippedTransactionV2 struct {
	// Tx is the skipped transaction.
	// We store the tx itself otherwise geth will discard it after skipping.
	Tx *types.Transaction

	// Traces is the serialized wrapped traces of the skipped transaction.
	// We only store it when `MinerStoreSkippedTxTracesFlag` is enabled, so it might be empty.
	// Note that we do not directly utilize `*types.BlockTrace` due to the fact that
	// types.BlockTrace.StorageTrace.Proofs is of type `map[string][]hexutil.Bytes`, which is not RLP-serializable.
	TracesBytes []byte

	// Reason is the skip reason.
	Reason string

	// BlockNumber is the number of the block in which this transaction was skipped.
	BlockNumber uint64

	// BlockHash is the hash of the block in which this transaction was skipped or nil.
	BlockHash *common.Hash
}

SkippedTransactionV2 stores the SkippedTransaction object along with serialized traces.

func ReadSkippedTransaction 

func ReadSkippedTransaction(db ethdb.Reader, txHash common.Hash) *SkippedTransactionV2

ReadSkippedTransaction retrieves a skipped transaction by its hash, along with its skipped reason.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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