rawdb

package
v3.2.9-0...-7b42c11 Latest Latest
Warning

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

 Go to latest Published: Aug 22, 2019 License: GPL-3.0 Imports: 12 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 

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

DeleteBlock removes all block data associated with a 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 common.Database, number uint64)

DeleteCanonicalHash removes the number to hash canonical mapping.

func DeleteHeader 

func DeleteHeader(global, headerTable common.Deleter, 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 DeleteTd 

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

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

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 Must 

func Must(op string, fn func() error)

Must executes fn, repeatedly retrying (with increasing delay) until it returns nil. op describes the operation for error logging.

func PreimageTablePrefixer 

func PreimageTablePrefixer(tbl common.Table) common.Table

PreimageTablePrefixer returns a Table instance with the key prefix for preimage entries.

func ReadBlock 

func ReadBlock(db common.Database, 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 DatabaseReader, bit uint, section uint64, head common.Hash) []byte

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 common.Database, 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 ReadDatabaseVersion 

func ReadDatabaseVersion(db DatabaseReader) *uint64

ReadDatabaseVersion retrieves the version number of the database.

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

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

ReadPreimage retrieves a single preimage of the provided hash.

func ReadRawReceipts 

func ReadRawReceipts(db DatabaseReader, 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 common.Database, 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 common.Database, hash common.Hash, number uint64, config *params.ChainConfig) types.Receipts

ReadReceipts retrieves all the transaction receipts belonging to a block, including its corresponding 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 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 common.Database, 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) *uint64

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

func WriteBlock 

func WriteBlock(db common.Database, block *types.Block)

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

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 stores 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 common.Database, 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 WriteDatabaseVersion 

func WriteDatabaseVersion(db DatabaseWriter, version uint64)

WriteDatabaseVersion stores the version number of 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 WriteHeader 

func WriteHeader(global, headerTable common.Putter, header *types.Header)

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

func WritePreimages 

func WritePreimages(tbl common.Table, 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 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 returns the data for key, or an error. Must return common.ErrNotFound when not found.
	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 LegacyTxLookupEntry 

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.