rawdb

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Jan 14, 2021 License: LGPL-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 DatabaseDeleter, 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 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 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 GetBloomTrieRoot 

func GetBloomTrieRoot(db youdb.Reader, sectionIdx uint64, sectionHead common.Hash) common.Hash

GetBloomTrieRoot reads the BloomTrie root assoctiated to the given section from the database

func GetChtRoot 

func GetChtRoot(db youdb.Reader, sectionIdx uint64, sectionHead common.Hash) common.Hash

GetChtRoot reads the CHT root associated to the given section from the database

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 ReadBlock 

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 

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 ReadDatabaseVersion 

func ReadDatabaseVersion(db DatabaseReader) int

ReadDatabaseVersion retrieves the version number of the database.

func ReadFastSyncUndoneFlag 

func ReadFastSyncUndoneFlag(db DatabaseReader) uint8

func ReadFastTrieProgress 

func ReadFastTrieProgress(db DatabaseReader) uint64

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

func ReadFastVldTrieHeight 

func ReadFastVldTrieHeight(db DatabaseReader) (height uint64)

func ReadFullOriginBlockNumber 

func ReadFullOriginBlockNumber(db DatabaseReader) *big.Int

ReadFullOriginBlockNumber retrieves the origin number that starting full sync.

func ReadHeadBlockHash 

func ReadHeadBlockHash(db DatabaseReader) common.Hash

ReadHeadBlockHash retrieves the hash of the current canonical 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 ReadLightStartHeaderHash 

func ReadLightStartHeaderHash(db DatabaseReader) common.Hash

ReadLightStartHeaderHash retrieves the hash of the start header of a light-client.

func ReadNetworkId 

func ReadNetworkId(db DatabaseReader, hash common.Hash) (networkId uint64)

ReadNetworkId retrieves the consensus settings based on the given genesis 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.

func ReadReceipts 

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

ReadReceipts retrieves all the transaction receipts belonging to a block.

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 StoreBloomTrieRoot 

func StoreBloomTrieRoot(db youdb.Putter, sectionIdx uint64, sectionHead, root common.Hash) error

StoreBloomTrieRoot writes the BloomTrie root assoctiated to the given section into the database

func StoreChtRoot 

func StoreChtRoot(db youdb.Putter, sectionIdx uint64, sectionHead, root common.Hash) error

StoreChtRoot writes the CHT root associated to the given section into the database

func WriteBlock 

func WriteBlock(db DatabaseWriter, 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 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 WriteDatabaseVersion 

func WriteDatabaseVersion(db DatabaseWriter, version int)

WriteDatabaseVersion stores the version number of the database

func WriteFastSyncUndoneFlag 

func WriteFastSyncUndoneFlag(db DatabaseWriter, flag uint8)

func WriteFastTrieProgress 

func WriteFastTrieProgress(db DatabaseWriter, count uint64)

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

func WriteFastVldTrieHeight 

func WriteFastVldTrieHeight(db DatabaseWriter, height uint64)

func WriteFullOriginBlockNumber 

func WriteFullOriginBlockNumber(db DatabaseWriter, number *big.Int)

WriteFullOriginBlockNumber stores the origin number that starting full sync.

func WriteHeadBlockHash 

func WriteHeadBlockHash(db DatabaseWriter, hash common.Hash)

WriteHeadBlockHash stores the head block's hash.

func WriteHeadHeaderHash 

func WriteHeadHeaderHash(db DatabaseWriter, hash common.Hash)

WriteHeadHeaderHash stores the hash of the current canonical head header.

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 WriteLightStartHeaderHash 

func WriteLightStartHeaderHash(db DatabaseWriter, hash common.Hash)

WriteLightStartHeaderHash stores the hash of the current start header of a light-client.

func WriteNetworkId 

func WriteNetworkId(db DatabaseWriter, hash common.Hash, networkId uint64)

WriteNetworkId writes the networkId to the database.

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

type AcReader interface {
	//ReadAcNode gets the node data (chtRoot, bltRoot) if headNum is multiples of params.ACoCHTFrequency
	ReadAcNode(headNum uint64, parentHash common.Hash) (chtRoot, bltRoot []byte, err error)
	//ReadCHTRootWithWait gets the chtRoot from database if headNum is multiples of params.ACoCHTFrequency, with a timeout.
	ReadCHTRootWithWait(headNum uint64, parentHash common.Hash, timeout time.Duration) (chtRoot []byte, err error)
}

AcReader contains functions for the main consensus engine to read data about ACoCHT

func NewAcReader 

func NewAcReader(db youdb.Reader) AcReader

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.