rawdb

package
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Dec 30, 2020 License: GPL-3.0 Imports: 10 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 (

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

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

DeleteBlock removes all block data associated with a hash.

func DeleteBody added in v1.1.0 

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

DeleteBody removes all block body data associated with a hash.

func DeleteCanonicalHash added in v1.1.0 

func DeleteCanonicalHash(db DatabaseDeleter, number uint64)

DeleteCanonicalHash removes the number to hash canonical mapping.

func DeleteHeader added in v1.1.0 

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

DeleteHeader removes all block header data associated with a hash.

func DeleteReceipts added in v1.1.0 

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

DeleteReceipts removes all receipt data associated with a block hash.

func DeleteTd added in v1.1.0 

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

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

func DeleteTxLookupEntry added in v1.1.0 

func DeleteTxLookupEntry(db DatabaseDeleter, hash common.Hash)

DeleteTxLookupEntry removes all transaction data associated with a hash.

func FindCommonAncestor added in v1.1.0 

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

FindCommonAncestor returns the last common ancestor of two block headers

func HasBody added in v1.1.0 

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

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

func HasHeader added in v1.1.0 

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

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

func HasReceipts added in v1.1.0 

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

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

func ReadBlock added in v1.1.0 

func ReadBlock(db DatabaseReader, 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 added in v1.1.0 

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

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

ReadBody retrieves the block body corresponding to the hash.

func ReadBodyRLP added in v1.1.0 

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

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

func ReadCanonicalHash added in v1.1.0 

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

ReadCanonicalHash retrieves the hash assigned to a canonical block number.

func ReadChainConfig added in v1.1.0 

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

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

func ReadDatabaseVersion added in v1.1.0 

func ReadDatabaseVersion(db DatabaseReader) *uint64

ReadDatabaseVersion retrieves the version number of the database.

func ReadFastTrieProgress added in v1.1.0 

func ReadFastTrieProgress(db DatabaseReader) uint64

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

func ReadHeadBlockHash added in v1.1.0 

func ReadHeadBlockHash(db DatabaseReader) common.Hash

ReadHeadBlockHash retrieves the hash of the current canonical head block.

func ReadHeadFastBlockHash added in v1.1.0 

func ReadHeadFastBlockHash(db DatabaseReader) common.Hash

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

func ReadHeadHeaderHash added in v1.1.0 

func ReadHeadHeaderHash(db DatabaseReader) common.Hash

ReadHeadHeaderHash retrieves the hash of the current canonical head header.

func ReadHeader added in v1.1.0 

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

ReadHeader retrieves the block header corresponding to the hash.

func ReadHeaderNumber added in v1.1.0 

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

ReadHeaderNumber returns the header number assigned to a hash.

func ReadHeaderRLP added in v1.1.0 

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

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

func ReadPreimage added in v1.1.0 

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

ReadPreimage retrieves a single preimage of the provided hash.

func ReadReceipt added in v1.1.0 

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.

func ReadReceipts added in v1.1.0 

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

ReadReceipts retrieves all the transaction receipts belonging to a block.

func ReadTd added in v1.1.0 

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

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

func ReadTransaction added in v1.1.0 

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

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 WriteBlock added in v1.1.0 

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

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

func WriteBloomBits added in v1.1.0 

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

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

WriteBody storea a block body into the database.

func WriteBodyRLP added in v1.1.0 

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

WriteBodyRLP stores an RLP encoded block body into the database.

func WriteCanonicalHash added in v1.1.0 

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

WriteCanonicalHash stores the hash assigned to a canonical block number.

func WriteChainConfig added in v1.1.0 

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

WriteChainConfig writes the chain config settings to the database.

func WriteDatabaseVersion added in v1.1.0 

func WriteDatabaseVersion(db DatabaseWriter, version uint64)

WriteDatabaseVersion stores the version number of the database

func WriteFastTrieProgress added in v1.1.0 

func WriteFastTrieProgress(db DatabaseWriter, count uint64)

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

func WriteHeadBlockHash added in v1.1.0 

func WriteHeadBlockHash(db DatabaseWriter, hash common.Hash)

WriteHeadBlockHash stores the head block's hash.

func WriteHeadFastBlockHash added in v1.1.0 

func WriteHeadFastBlockHash(db DatabaseWriter, hash common.Hash)

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

func WriteHeadHeaderHash added in v1.1.0 

func WriteHeadHeaderHash(db DatabaseWriter, hash common.Hash)

WriteHeadHeaderHash stores the hash of the current canonical head header.

func WriteHeader added in v1.1.0 

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

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

func WritePreimages added in v1.1.0 

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

WritePreimages writes the provided set of preimages to the database.

func WriteReceipts added in v1.1.0 

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

WriteReceipts stores all the transaction receipts belonging to a block.

func WriteTd added in v1.1.0 

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

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

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

DatabaseDeleter wraps the Delete method of a backing data store.

type DatabaseReader added in v1.1.0 

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

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

DatabaseWriter wraps the Put method of a backing data store.

type TxLookupEntry added in v1.1.0 

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.