rawdb

package
v2.1.4+incompatible Latest Latest
Warning

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

 Go to latest Published: Aug 6, 2022 License: GPL-3.0 Imports: 19 Imported by: 15

Documentation

Overview

Package rawdb contains a collection of low level database accessors.

Index

Constants

This section is empty.

Variables

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

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

Functions

func DeleteAccountSnapshot 

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

DeleteAccountSnapshot removes the snapshot entry of an account trie leaf.

func DeleteBalanceInfo 

func DeleteBalanceInfo(db DatabaseDeleter, height uint64)

func DeleteBlock 

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

DeleteBlock removes all block data associated with a hash.

func DeleteBlockReward 

func DeleteBlockReward(db DatabaseDeleter, hash common.Hash, number uint64)

DeleteReceipts removes all receipt data associated with a block hash.

func DeleteBody 

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

DeleteBody removes all block body data associated with a hash.

func DeleteCanonicalHash 

func DeleteCanonicalHash(db DatabaseDeleter, number uint64)

DeleteCanonicalHash removes the number to hash canonical mapping.

func DeleteHeader 

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

DeleteHeader removes all block header data associated with a hash.

func DeleteReceipts 

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

DeleteReceipts removes all receipt data associated with a block hash.

func DeleteRewardInfo 

func DeleteRewardInfo(db DatabaseDeleter, snailHeight uint64)

func DeleteSnapshotDisabled 

func DeleteSnapshotDisabled(db etruedb.KeyValueWriter)

DeleteSnapshotDisabled deletes the flag keeping the snapshot maintenance disabled.

func DeleteSnapshotGenerator 

func DeleteSnapshotGenerator(db etruedb.KeyValueWriter)

DeleteSnapshotGenerator deletes the serialized snapshot generator saved at the last shutdown

func DeleteSnapshotJournal 

func DeleteSnapshotJournal(db etruedb.KeyValueWriter)

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

func DeleteSnapshotRecoveryNumber 

func DeleteSnapshotRecoveryNumber(db etruedb.KeyValueWriter)

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

func DeleteSnapshotRoot 

func DeleteSnapshotRoot(db etruedb.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 etruedb.KeyValueWriter)

DeleteSnapshotSyncStatus deletes the serialized sync status saved at the last shutdown

func DeleteStorageSnapshot 

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

DeleteStorageSnapshot removes the snapshot entry of an storage trie leaf.

func DeleteTxLookupEntry 

func DeleteTxLookupEntry(db DatabaseDeleter, hash common.Hash)

DeleteTxLookupEntry removes all transaction data associated with a hash.

func FindCommonAncestor 

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

FindCommonAncestor returns the last common ancestor of two block headers

func HasBody 

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

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

func HasHeader 

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

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

func HasReceipts 

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

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

func HasTxLookupEntry 

func HasTxLookupEntry(db DatabaseReader, hash common.Hash) bool

HasTxLookupEntry verifies the existence of a txLookup entry corresponding to the hash.

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 etruedb.Iteratee, accountHash common.Hash) etruedb.Iterator

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

func NewFreezerTable 

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

NewFreezerTable opens the given path as a freezer table.

func ReadAccountSnapshot 

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

ReadAccountSnapshot retrieves the snapshot entry of an account trie leaf.

func ReadBalanceInfo 

func ReadBalanceInfo(db DatabaseReader, height uint64) *types.BlockBalance

func ReadBlock 

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

TODO WithBody(body.Transactions,nil) nil: signs []*SignInfo

func ReadBlockReward 

func ReadBlockReward(db DatabaseReader, number uint64) *types.BlockReward

func ReadBlockRewardRLP 

func ReadBlockRewardRLP(db DatabaseReader, number uint64) rlp.RawValue

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

func ReadBloomBits 

func ReadBloomBits(db DatabaseReader, 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 DatabaseReader, hash common.Hash, number uint64) *types.Body

ReadBody retrieves the block body corresponding to the hash.

func ReadBodyRLP 

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

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

func ReadCanonicalHash 

func ReadCanonicalHash(db DatabaseReader, number uint64) common.Hash

ReadCanonicalHash retrieves the hash assigned to a canonical block number.

func ReadChainConfig 

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

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

func ReadCommitteeInfo 

func ReadCommitteeInfo(db DatabaseReader, hash common.Hash, number uint64) []*types.CommitteeMember

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

func ReadFastTrieProgress 

func ReadFastTrieProgress(db DatabaseReader) uint64

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

func ReadHeadBlockHash 

func ReadHeadBlockHash(db DatabaseReader) common.Hash

ReadHeadBlockHash retrieves the hash of the current canonical head block.

func ReadHeadFastBlockHash 

func ReadHeadFastBlockHash(db DatabaseReader) common.Hash

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

func ReadHeadHeaderHash 

func ReadHeadHeaderHash(db DatabaseReader) common.Hash

ReadHeadHeaderHash retrieves the hash of the current canonical head header.

func ReadHeadRewardNumber 

func ReadHeadRewardNumber(db DatabaseReader) uint64

ReadHeadBlockHash retrieves the hash of the current canonical head block.

func ReadHeader 

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

ReadHeader retrieves the block header corresponding to the hash.

func ReadHeaderNumber 

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

ReadHeaderNumber returns the header number assigned to a hash.

func ReadHeaderRLP 

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

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

func ReadLastBlockHash added in v0.10.1 

func ReadLastBlockHash(db DatabaseReader) common.Hash

ReadLastBlockNumber retrieves the hash of the current canonical head block.

func ReadPreimage 

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

ReadPreimage retrieves a single preimage of the provided hash.

func ReadReceipt 

func ReadReceipt(db DatabaseReader, hash common.Hash) (*types.Receipt, common.Hash, uint64, uint64)

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

func ReadReceipts 

func ReadReceipts(db DatabaseReader, hash common.Hash, number uint64) types.Receipts

ReadReceipts retrieves all the transaction receipts belonging to a block.

func ReadRewardInfo 

func ReadRewardInfo(db DatabaseReader, snailHeight uint64) *types.ChainReward

func ReadSnapBlock 

func ReadSnapBlock(db DatabaseReader, hash common.Hash, number uint64) *types.Block

ReadSnapBlock retrieves an snap block corresponding to the hash, assembling it back from the stored header. If either the header could not be retrieved nil is returned.

Note, due to concurrent download of header the header and thus canonical hash can be stored in the database but the body data not (yet).

func ReadSnapshotDisabled 

func ReadSnapshotDisabled(db etruedb.KeyValueReader) bool

ReadSnapshotDisabled retrieves if the snapshot maintenance is disabled.

func ReadSnapshotGenerator 

func ReadSnapshotGenerator(db etruedb.KeyValueReader) []byte

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

func ReadSnapshotJournal 

func ReadSnapshotJournal(db etruedb.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 etruedb.KeyValueReader) *uint64

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

func ReadSnapshotRoot 

func ReadSnapshotRoot(db etruedb.KeyValueReader) common.Hash

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

func ReadSnapshotSyncStatus 

func ReadSnapshotSyncStatus(db etruedb.KeyValueReader) []byte

ReadSnapshotSyncStatus retrieves the serialized sync status saved at shutdown.

func ReadStateGcBR 

func ReadStateGcBR(db DatabaseReader) uint64

ReadFastTrieProgress retrieves the number of body and receipt state synced to allow reporting correct numbers across restarts.

func ReadStorageSnapshot 

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

ReadStorageSnapshot retrieves the snapshot entry of an storage trie leaf.

func ReadTd 

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

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

func ReadTransaction 

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

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

func ReadTxLookupEntry 

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

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

func WriteAccountSnapshot 

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

WriteAccountSnapshot stores the snapshot entry of an account trie leaf.

func WriteBalanceInfo 

func WriteBalanceInfo(db DatabaseWriter, height uint64, infos *types.BlockBalance)

func WriteBlock 

func WriteBlock(db DatabaseWriter, block *types.Block)

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

func WriteBlockReward 

func WriteBlockReward(db DatabaseWriter, block *types.BlockReward)

WriteReward serializes a blockReward into the database.

func WriteBloomBits 

func WriteBloomBits(db DatabaseWriter, 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 DatabaseWriter, hash common.Hash, number uint64, body *types.Body)

WriteBody storea a block body into the database.

func WriteBodyRLP 

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

WriteBodyRLP stores an RLP encoded block body into the database.

func WriteCanonicalHash 

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

WriteCanonicalHash stores the hash assigned to a canonical block number.

func WriteChainConfig 

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

WriteChainConfig writes the chain config settings to the database.

func WriteCommitteeInfo 

func WriteCommitteeInfo(db DatabaseWriter, hash common.Hash, number uint64, info []*types.CommitteeMember)

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

func WriteFastTrieProgress 

func WriteFastTrieProgress(db DatabaseWriter, count uint64)

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

func WriteHeadBlockHash 

func WriteHeadBlockHash(db DatabaseWriter, hash common.Hash)

WriteHeadBlockHash stores the head block's hash.

func WriteHeadFastBlockHash 

func WriteHeadFastBlockHash(db DatabaseWriter, hash common.Hash)

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

func WriteHeadHeaderHash 

func WriteHeadHeaderHash(db DatabaseWriter, hash common.Hash)

WriteHeadHeaderHash stores the hash of the current canonical head header.

func WriteHeadRewardNumber 

func WriteHeadRewardNumber(db DatabaseWriter, number uint64)

WriteHeadBlockHash stores the head block's hash.

func WriteHeader 

func WriteHeader(db DatabaseWriter, header *types.Header)

WriteHeader stores a block header into the database and also stores the hash- to-number mapping.

func WriteLastBlockHash added in v0.10.1 

func WriteLastBlockHash(db DatabaseWriter, hash common.Hash)

WriteLastBlockNumber stores the head block's hash.

func WritePreimages 

func WritePreimages(db DatabaseWriter, number uint64, preimages map[common.Hash][]byte)

WritePreimages writes the provided set of preimages to the database. `number` is the current block number, and is used for debug messages only.

func WriteReceipts 

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

WriteReceipts stores all the transaction receipts belonging to a block.

func WriteRewardInfo 

func WriteRewardInfo(db DatabaseWriter, snailHeight uint64, infos *types.ChainReward)

func WriteSnapshotDisabled 

func WriteSnapshotDisabled(db etruedb.KeyValueWriter)

WriteSnapshotDisabled stores the snapshot pause flag.

func WriteSnapshotGenerator 

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

WriteSnapshotGenerator stores the serialized snapshot generator to save at shutdown.

func WriteSnapshotJournal 

func WriteSnapshotJournal(db etruedb.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 etruedb.KeyValueWriter, number uint64)

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

func WriteSnapshotRoot 

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

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

func WriteSnapshotSyncStatus 

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

WriteSnapshotSyncStatus stores the serialized sync status to save at shutdown.

func WriteStateGcBR 

func WriteStateGcBR(db DatabaseWriter, count uint64)

WriteStateGcBR stores the state sync body and receipt counter to support retrieving it across restarts.

func WriteStorageSnapshot 

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

WriteStorageSnapshot stores the snapshot entry of an storage trie leaf.

func WriteTd 

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

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

func WriteTxLookupEntries 

func WriteTxLookupEntries(db DatabaseWriter, block *types.Block)

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

Types

type DatabaseDeleter 

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

DatabaseDeleter wraps the Delete method of a backing data store.

type DatabaseReader 

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

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

type DatabaseWriter 

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

DatabaseWriter wraps the Put method of a backing data store.

type TxLookupEntry 

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

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

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.