rawdb

package
v1.9.57-beta Latest Latest
Warning

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

 Go to latest Published: May 14, 2020 License: GPL-3.0, GPL-3.0 Imports: 29 Imported by: 6

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

	// 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 added in v1.9.52 

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

DeleteAccountSnapshot removes the snapshot entry of an account trie leaf.

func DeleteBlock 

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

DeleteBlock removes all block data associated with a hash.

func DeleteBlockWithoutNumber added in v1.9.51 

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

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

func DeleteBody 

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

DeleteBody removes all block body data associated with a hash.

func DeleteCanonicalHash 

func DeleteCanonicalHash(db ctxcdb.KeyValueWriter, number uint64)

DeleteCanonicalHash removes the number to hash canonical mapping.

func DeleteHeader 

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

DeleteHeader removes all block header data associated with a hash.

func DeleteHeaderNumber added in v1.9.51 

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

DeleteHeaderNumber removes hash->number mapping.

func DeleteReceipts 

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

DeleteReceipts removes all receipt data associated with a block hash.

func DeleteSnapshotJournal added in v1.9.52 

func DeleteSnapshotJournal(db ctxcdb.KeyValueWriter)

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

func DeleteSnapshotRoot added in v1.9.52 

func DeleteSnapshotRoot(db ctxcdb.KeyValueWriter)

DeleteSnapshotRoot deletes the hash of the block whose state is contained in the persisted snapshot. Since snapshots are not immutable, this method can be used during updates, so a crash or failure will mark the entire snapshot invalid.

func DeleteStorageSnapshot added in v1.9.52 

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

DeleteStorageSnapshot removes the snapshot entry of an storage trie leaf.

func DeleteTd 

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

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

func DeleteTxLookupEntriesByHash added in v1.10.0 

func DeleteTxLookupEntriesByHash(db ctxcdb.KeyValueWriter, hashes []common.Hash)

DeleteTxLookupEntries removes all transaction lookups for a given block.

func DeleteTxLookupEntry 

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

DeleteTxLookupEntry removes all transaction data associated with a hash.

func FindCommonAncestor 

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

FindCommonAncestor returns the last common ancestor of two block headers

func HasBody 

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

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

func HasHeader 

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

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

func HasReceipts added in v1.9.51 

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

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

func IndexTransactions added in v1.10.0 

func IndexTransactions(db ctxcdb.Database, from uint64, to uint64)

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.

func InitDatabaseFromFreezer added in v1.9.51 

func InitDatabaseFromFreezer(db ctxcdb.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 added in v1.9.51 

func InspectDatabase(db ctxcdb.Database) error

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

func IterateStorageSnapshots added in v1.9.52 

func IterateStorageSnapshots(db ctxcdb.Iteratee, accountHash common.Hash) ctxcdb.Iterator

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

func NewDatabase added in v1.9.51 

func NewDatabase(db ctxcdb.KeyValueStore) ctxcdb.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 added in v1.9.51 

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

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

func NewLevelDBDatabase added in v1.9.51 

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

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

func NewLevelDBDatabaseWithFreezer added in v1.9.51 

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

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

func NewMemoryDatabase added in v1.9.51 

func NewMemoryDatabase() ctxcdb.Database

NewMemoryDatabase creates an ephemeral in-memory key-value database without a freezer moving immutable chain segments into cold storage.

func NewMemoryDatabaseWithCap added in v1.9.51 

func NewMemoryDatabaseWithCap(size int) ctxcdb.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 added in v1.9.51 

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

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

func ReadAccountSnapshot added in v1.9.52 

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

ReadAccountSnapshot retrieves the snapshot entry of an account trie leaf.

func ReadAllHashes added in v1.9.51 

func ReadAllHashes(db ctxcdb.Iteratee, number uint64) []common.Hash

ReadAllHashes retrieves all the hashes assigned to blocks at a certain heights, both canonical and reorged forks included.

func ReadBlock 

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

ReadBlock retrieves an entire block corresponding to the hash, assembling it back from the stored header and body. If either the header or body could not be retrieved nil is returned.

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

func ReadBloomBits 

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

ReadBody retrieves the block body corresponding to the hash.

func ReadBodyRLP 

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

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

func ReadCanonicalBodyRLP added in v1.10.0 

func ReadCanonicalBodyRLP(db ctxcdb.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 ctxcdb.Reader, number uint64) common.Hash

ReadCanonicalHash retrieves the hash assigned to a canonical block number.

func ReadChainConfig 

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

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

func ReadDatabaseVersion 

func ReadDatabaseVersion(db ctxcdb.KeyValueReader) *uint64

ReadDatabaseVersion retrieves the version number of the database.

func ReadFastTrieProgress 

func ReadFastTrieProgress(db ctxcdb.KeyValueReader) uint64

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

func ReadFastTxLookupLimit added in v1.10.0 

func ReadFastTxLookupLimit(db ctxcdb.KeyValueReader) *uint64

ReadFastTxLookupLimit retrieves the tx lookup limit used in fast sync.

func ReadHeadBlockHash 

func ReadHeadBlockHash(db ctxcdb.KeyValueReader) common.Hash

ReadHeadBlockHash retrieves the hash of the current canonical head block.

func ReadHeadFastBlockHash 

func ReadHeadFastBlockHash(db ctxcdb.KeyValueReader) common.Hash

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

func ReadHeadHeaderHash 

func ReadHeadHeaderHash(db ctxcdb.KeyValueReader) common.Hash

ReadHeadHeaderHash retrieves the hash of the current canonical head header.

func ReadHeader 

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

ReadHeader retrieves the block header corresponding to the hash.

func ReadHeaderNumber 

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

ReadHeaderNumber returns the header number assigned to a hash.

func ReadHeaderRLP 

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

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

func ReadPreimage 

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

ReadPreimage retrieves a single preimage of the provided hash.

func ReadRawReceipts added in v1.9.51 

func ReadRawReceipts(db ctxcdb.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 ctxcdb.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 ctxcdb.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 added in v1.9.51 

func ReadReceiptsRLP(db ctxcdb.Reader, hash common.Hash, number uint64) rlp.RawValue

ReadReceiptsRLP retrieves all the transaction receipts belonging to a block in RLP encoding.

func ReadSnapshotJournal added in v1.9.52 

func ReadSnapshotJournal(db ctxcdb.KeyValueReader) []byte

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

func ReadSnapshotRoot added in v1.9.52 

func ReadSnapshotRoot(db ctxcdb.KeyValueReader) common.Hash

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

func ReadStorageSnapshot added in v1.9.52 

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

ReadStorageSnapshot retrieves the snapshot entry of an storage trie leaf.

func ReadTd 

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

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

func ReadTdRLP added in v1.9.51 

func ReadTdRLP(db ctxcdb.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 ctxcdb.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 ReadTxIndexTail added in v1.10.0 

func ReadTxIndexTail(db ctxcdb.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 ctxcdb.Reader, hash common.Hash) *uint64

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

func UnindexTransactions added in v1.10.0 

func UnindexTransactions(db ctxcdb.Database, from uint64, to uint64)

UnindexTransactions removes txlookup indices of the specified block range.

func WriteAccountSnapshot added in v1.9.52 

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

WriteAccountSnapshot stores the snapshot entry of an account trie leaf.

func WriteAncientBlock added in v1.9.51 

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

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

func WriteBlock 

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

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

func WriteBloomBits 

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

WriteBody stores a block body into the database.

func WriteBodyRLP 

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

WriteBodyRLP stores an RLP encoded block body into the database.

func WriteCanonicalHash 

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

WriteCanonicalHash stores the hash assigned to a canonical block number.

func WriteChainConfig 

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

WriteChainConfig writes the chain config settings to the database.

func WriteDatabaseVersion 

func WriteDatabaseVersion(db ctxcdb.KeyValueWriter, version uint64)

WriteDatabaseVersion stores the version number of the database

func WriteFastTrieProgress 

func WriteFastTrieProgress(db ctxcdb.KeyValueWriter, count uint64)

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

func WriteFastTxLookupLimit added in v1.10.0 

func WriteFastTxLookupLimit(db ctxcdb.KeyValueWriter, number uint64)

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

func WriteHeadBlockHash 

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

WriteHeadBlockHash stores the head block's hash.

func WriteHeadFastBlockHash 

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

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

func WriteHeadHeaderHash 

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

WriteHeadHeaderHash stores the hash of the current canonical head header.

func WriteHeader 

func WriteHeader(db ctxcdb.KeyValueWriter, header *types.Header)

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

func WriteHeaderNumber added in v1.9.51 

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

WriteHeaderNumber stores the hash->number mapping.

func WritePreimages 

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

WritePreimages writes the provided set of preimages to the database.

func WriteReceipts 

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

WriteReceipts stores all the transaction receipts belonging to a block.

func WriteSnapshotJournal added in v1.9.52 

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

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

func WriteSnapshotRoot added in v1.9.52 

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

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

func WriteStorageSnapshot added in v1.9.52 

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

WriteStorageSnapshot stores the snapshot entry of an storage trie leaf.

func WriteTd 

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

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

func WriteTxIndexTail added in v1.10.0 

func WriteTxIndexTail(db ctxcdb.KeyValueWriter, number uint64)

WriteTxIndexTail stores the number of oldest indexed block into database.

func WriteTxLookupEntries 

func WriteTxLookupEntries(db ctxcdb.KeyValueWriter, block *types.Block)

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

func WriteTxLookupEntriesByHash added in v1.10.0 

func WriteTxLookupEntriesByHash(db ctxcdb.KeyValueWriter, number uint64, hashes []common.Hash)

WriteTxLookupEntriesByHash is identical to WriteTxLookupEntries, but does not require a full types.Block as input.

Types

type LegacyTxLookupEntry added in v1.9.51 

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

LegacyTxLookupEntry is the legacy TxLookupEntry definition with some unnecessary fields.

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.