rawdb

package
v1.3.1 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2021 License: GPL-3.0 Imports: 17 Imported by: 0

Documentation

Overview

Package rawdb contains a collection of low level database accessors.

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 neatdb.Writer, hash common.Hash, number uint64)

DeleteBlock removes all block data associated with a hash.

func DeleteBody 

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

DeleteBody removes all block body data associated with a hash.

func DeleteCanonicalHash 

func DeleteCanonicalHash(db neatdb.Writer, number uint64)

DeleteCanonicalHash removes the number to hash canonical mapping.

func DeleteDataPruneTrieRootHash 

func DeleteDataPruneTrieRootHash(db neatdb.Writer, scan, prune uint64)

DeleteCanonicalHash removes the number to hash canonical mapping.

func DeleteHeader 

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

DeleteHeader removes all block header data associated with a hash.

func DeletePreimage 

func DeletePreimage(db neatdb.Writer, hash common.Hash)

DeletePreimage delete a single preimage of the provided hash. (Use carefully)

func DeleteReceipts 

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

DeleteReceipts removes all receipt data associated with a block hash.

func DeleteTX3 

func DeleteTX3(db neatdb.Database, chainId string, txHash common.Hash)

func DeleteTd 

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

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

func DeleteTxLookupEntry 

func DeleteTxLookupEntry(db neatdb.Writer, hash common.Hash)

DeleteTxLookupEntry removes all transaction data associated with a hash.

func FindCommonAncestor 

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

FindCommonAncestor returns the last common ancestor of two block headers

func GetAllTX3ProofData 

func GetAllTX3ProofData(db neatdb.Database) []*types.TX3ProofData

func GetTX3 

func GetTX3(db neatdb.Reader, chainId string, txHash common.Hash) *types.Transaction

func GetTX3LookupEntry 

func GetTX3LookupEntry(db neatdb.Reader, chainId string, txHash common.Hash) (common.Hash, uint64, uint64)

func GetTX3ProofData 

func GetTX3ProofData(db neatdb.Reader, chainId string, txHash common.Hash) *types.TX3ProofData

func HasBody 

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

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

func HasHeader 

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

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

func HasReceipts 

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

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

func NewDatabase 

func NewDatabase(db neatdb.KeyValueStore) neatdb.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 NewLevelDBDatabase 

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

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

func NewMemoryDatabase 

func NewMemoryDatabase() neatdb.Database

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

func NewMemoryDatabaseWithCap 

func NewMemoryDatabaseWithCap(size int) neatdb.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 

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

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

func ReadBlock 

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

ReadBody retrieves the block body corresponding to the hash.

func ReadBodyRLP 

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

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

func ReadCanonicalHash 

func ReadCanonicalHash(db neatdb.Reader, number uint64) common.Hash

ReadCanonicalHash retrieves the hash assigned to a canonical block number.

func ReadChainConfig 

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

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

func ReadDataPruneTrieRootHash 

func ReadDataPruneTrieRootHash(db neatdb.Reader, scan, prune uint64) common.Hash

ReadDataPruneTrieRootHash retrieves the root hash of a data prune process trie

func ReadDatabaseVersion 

func ReadDatabaseVersion(db neatdb.Reader) *uint64

ReadDatabaseVersion retrieves the version number of the database.

func ReadFastTrieProgress 

func ReadFastTrieProgress(db neatdb.Reader) uint64

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

func ReadHeadBlockHash 

func ReadHeadBlockHash(db neatdb.Reader) common.Hash

ReadHeadBlockHash retrieves the hash of the current canonical head block.

func ReadHeadFastBlockHash 

func ReadHeadFastBlockHash(db neatdb.Reader) common.Hash

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

func ReadHeadHeaderHash 

func ReadHeadHeaderHash(db neatdb.Reader) common.Hash

ReadHeadHeaderHash retrieves the hash of the current canonical head header.

func ReadHeadPruneNumber 

func ReadHeadPruneNumber(db neatdb.Reader) *uint64

ReadHeadPruneNumber retrieves the latest pruned number.

func ReadHeadScanNumber 

func ReadHeadScanNumber(db neatdb.Reader) *uint64

ReadHeadScanNumber retrieves the latest scaned number.

func ReadHeader 

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

ReadHeader retrieves the block header corresponding to the hash.

func ReadHeaderNumber 

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

ReadHeaderNumber returns the header number assigned to a hash.

func ReadHeaderRLP 

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

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

func ReadPreimage 

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

ReadPreimage retrieves a single preimage of the provided hash.

func ReadReceipt 

func ReadReceipt(db neatdb.Reader, 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 neatdb.Reader, hash common.Hash, number uint64) types.Receipts

ReadReceipts retrieves all the transaction receipts belonging to a block.

func ReadReceiptsRLP 

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

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

func ReadTd 

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

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

func ReadTdRLP 

func ReadTdRLP(db neatdb.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 neatdb.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 ReadTxLookupEntry 

func ReadTxLookupEntry(db neatdb.Reader, hash common.Hash) common.Hash

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

func WriteBlock 

func WriteBlock(db neatdb.Writer, block *types.Block)

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

func WriteBloomBits 

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

WriteBody storea a block body into the database.

func WriteBodyRLP 

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

WriteBodyRLP stores an RLP encoded block body into the database.

func WriteCanonicalHash 

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

WriteCanonicalHash stores the hash assigned to a canonical block number.

func WriteChainConfig 

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

WriteChainConfig writes the chain config settings to the database.

func WriteDataPruneTrieRootHash 

func WriteDataPruneTrieRootHash(db neatdb.Writer, hash common.Hash, scan, prune uint64)

WriteCanonicalHash stores the hash assigned to a canonical block number.

func WriteDatabaseVersion 

func WriteDatabaseVersion(db neatdb.Writer, version uint64)

WriteDatabaseVersion stores the version number of the database

func WriteFastTrieProgress 

func WriteFastTrieProgress(db neatdb.Writer, count uint64)

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

func WriteHeadBlockHash 

func WriteHeadBlockHash(db neatdb.Writer, hash common.Hash)

WriteHeadBlockHash stores the head block's hash.

func WriteHeadFastBlockHash 

func WriteHeadFastBlockHash(db neatdb.Writer, hash common.Hash)

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

func WriteHeadHeaderHash 

func WriteHeadHeaderHash(db neatdb.Writer, hash common.Hash)

WriteHeadHeaderHash stores the hash of the current canonical head header.

func WriteHeadPruneNumber 

func WriteHeadPruneNumber(db neatdb.Writer, prune uint64)

WriteHeadPruneNumber stores the number of the latest pruned block.

func WriteHeadScanNumber 

func WriteHeadScanNumber(db neatdb.Writer, scan uint64)

WriteHeadScanNumber stores the number of the latest scaned block.

func WriteHeader 

func WriteHeader(db neatdb.Writer, header *types.Header)

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

func WritePreimages 

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

WritePreimages writes the provided set of preimages to the database.

func WriteReceipts 

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

WriteReceipts stores all the transaction receipts belonging to a block.

func WriteTX3 

func WriteTX3(db neatdb.Writer, chainId string, header *types.Header, txIndex uint, txProofData *types.BSKeyValueSet) error

func WriteTX3ProofData 

func WriteTX3ProofData(db neatdb.Database, proofData *types.TX3ProofData) error

WriteTX3ProofData serializes TX3ProofData into the database.

func WriteTd 

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

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

func WriteTxLookupEntries 

func WriteTxLookupEntries(db neatdb.Writer, block *types.Block)

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

Types

type LegacyTxLookupEntry 

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

LegacyTxLookupEntry is the legacy TxLookupEntry definition with some unnecessary fields.

type TX3LookupEntry 

type TX3LookupEntry struct {
	BlockIndex uint64
	TxIndex    uint64
}

TX3LookupEntry is a positional metadata to help looking up the tx3 proof content given only its chainId and 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.