rawdb

package
v0.41.1 Latest Latest
Warning

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

 Go to latest Published: Jan 2, 2025 License: GPL-3.0 Imports: 30 Imported by: 1

Documentation

Overview

Package rawdb contains a collection of low level database accessors.

Index

Constants

View Source 
const PebbleEnabled = true

Pebble is unsuported on 32bit architecture

Variables

View Source 
var (
	AddressUtxosPrefix   = []byte("au") // addressUtxosPrefix + address -> []types.UtxoEntry
	AddressLockupsPrefix = []byte("al") // addressLockupsPrefix + address -> []types.Lockup

	UtxoPrefix = []byte("ut") // outpointPrefix + hash -> types.Outpoint

	BloomBitsPrefix       = []byte("B") // bloomBitsPrefix + bit (uint16 big endian) + section (uint64 big endian) + hash -> bloom bits
	SnapshotAccountPrefix = []byte("a") // SnapshotAccountPrefix + account hash -> account trie value
	SnapshotStoragePrefix = []byte("o") // SnapshotStoragePrefix + account hash + storage hash -> storage trie value
	CodePrefix            = []byte("c") // CodePrefix + code hash -> account code

	// 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.

View Source 
var BloomBitsKeyLength = len(BloomBitsPrefix) + 2 + 8 + common.HashLength
View Source 
var File_core_rawdb_db_proto protoreflect.FileDescriptor
View Source 
var FreezerNoSnappy = map[string]bool{
	// contains filtered or unexported fields
}

FreezerNoSnappy configures whether compression is disabled for the ancient-tables. Hashes and difficulties don't compress well.

View Source 
var PrunedUtxoKeyWithDenominationLength = 9
View Source 
var UtxoKeyLength = len(UtxoPrefix) + common.HashLength + 2
View Source 
var UtxoKeyWithDenominationLength = len(UtxoPrefix) + common.HashLength + 3

Functions

func CreateUTXO added in v0.32.0 

func CreateUTXO(db ethdb.KeyValueWriter, txHash common.Hash, index uint16, utxo *types.UtxoEntry) error

func DeleteAccountSnapshot 

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

DeleteAccountSnapshot removes the snapshot entry of an account trie leaf.

func DeleteAllHeadsHashes 

func DeleteAllHeadsHashes(db ethdb.KeyValueWriter)

DeleteAllHeadsHashes writes the heads hashes of the blockchain.

func DeleteAllPbBodyKeys 

func DeleteAllPbBodyKeys(db ethdb.KeyValueWriter)

DeleteAllPbBodyKeys delete the pendingHeaderBody keys to the db

func DeleteBadHashesList 

func DeleteBadHashesList(db ethdb.KeyValueWriter)

DeleteBadHashesList removes badHashesList from the database

func DeleteBestPendingHeader added in v0.32.0 

func DeleteBestPendingHeader(db ethdb.KeyValueWriter)

DeleteBestPendingHeader deletes the pending header stored for the header hash.

func DeleteBestPhKey 

func DeleteBestPhKey(db ethdb.KeyValueWriter)

DeleteBestPhKey delete the bestPhKey of the blockchain

func DeleteBetas added in v0.35.0 

func DeleteBetas(db ethdb.KeyValueWriter, blockHash common.Hash)

func DeleteBlockWithoutNumber 

func DeleteBlockWithoutNumber(db ethdb.KeyValueWriter, hash common.Hash, number uint64, woType types.WorkObjectView)

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

func DeleteBloom 

func DeleteBloom(db ethdb.KeyValueWriter, hash common.Hash, number uint64)

DeleteBloom removes all bloom data associated with a block.

func DeleteBloombits 

func DeleteBloombits(db ethdb.Database, bit uint, from uint64, to uint64)

DeleteBloombits removes all compressed bloom bits vector belonging to the given section range and bit index.

func DeleteCanonicalHash 

func DeleteCanonicalHash(db ethdb.KeyValueWriter, number uint64)

DeleteCanonicalHash removes the number to hash canonical mapping.

func DeleteCode 

func DeleteCode(db ethdb.KeyValueWriter, hash common.Hash)

DeleteCode deletes the specified contract code from the database.

func DeleteCreatedUTXOKeys added in v0.32.0 

func DeleteCreatedUTXOKeys(db ethdb.KeyValueWriter, blockHash common.Hash)

func DeleteGenesisHashes added in v0.29.0 

func DeleteGenesisHashes(db ethdb.KeyValueWriter)

func DeleteHeader 

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

DeleteHeader removes all block header data associated with a hash.

func DeleteHeaderNumber 

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

DeleteHeaderNumber removes hash->number mapping.

func DeleteInboundEtxs 

func DeleteInboundEtxs(db ethdb.KeyValueWriter, hash common.Hash)

DeleteInboundEtxs deletes the inbound etxs from the database

func DeleteInterlinkHashes added in v0.29.0 

func DeleteInterlinkHashes(db ethdb.KeyValueWriter, hash common.Hash)

DeleteInterlinkHashes removes interlinkHashes data associated with a block.

func DeleteManifest 

func DeleteManifest(db ethdb.KeyValueWriter, hash common.Hash)

DeleteManifest removes manifest data associated with a block.

func DeleteOutpointsForAddress added in v0.32.0 

func DeleteOutpointsForAddress(db ethdb.KeyValueWriter, address [20]byte)

func DeletePbCacheBody 

func DeletePbCacheBody(db ethdb.KeyValueWriter, hash common.Hash)

DeletePbCacheBody removes all block body data associated with a hash.

func DeletePendingEtxs 

func DeletePendingEtxs(db ethdb.KeyValueWriter, hash common.Hash)

DeletePendingEtxs removes all pending ETX data associated with a block.

func DeletePendingEtxsRollup 

func DeletePendingEtxsRollup(db ethdb.KeyValueWriter, hash common.Hash)

DeletePendingEtxsRollup removes all pending ETX rollup data associated with a block.

func DeleteReceipts 

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

DeleteReceipts removes all receipt data associated with a block hash.

func DeleteSnapshotDisabled 

func DeleteSnapshotDisabled(db ethdb.KeyValueWriter)

DeleteSnapshotDisabled deletes the flag keeping the snapshot maintenance disabled.

func DeleteSnapshotGenerator 

func DeleteSnapshotGenerator(db ethdb.KeyValueWriter)

DeleteSnapshotGenerator deletes the serialized snapshot generator saved at the last shutdown

func DeleteSnapshotJournal 

func DeleteSnapshotJournal(db ethdb.KeyValueWriter)

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

func DeleteSnapshotRecoveryNumber 

func DeleteSnapshotRecoveryNumber(db ethdb.KeyValueWriter)

DeleteSnapshotRecoveryNumber deletes the block number of the last persisted snapshot layer.

func DeleteSnapshotRoot 

func DeleteSnapshotRoot(db ethdb.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 DeleteSnapshotSyncStatus 

func DeleteSnapshotSyncStatus(db ethdb.KeyValueWriter)

DeleteSnapshotSyncStatus deletes the serialized sync status saved at the last shutdown

func DeleteSpentUTXOs added in v0.32.0 

func DeleteSpentUTXOs(db ethdb.KeyValueWriter, blockHash common.Hash)

func DeleteStorageSnapshot 

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

DeleteStorageSnapshot removes the snapshot entry of an storage trie leaf.

func DeleteTermini 

func DeleteTermini(db ethdb.KeyValueWriter, hash common.Hash)

DeleteTermini writes the heads hashes of the blockchain.

func DeleteTokenChoicesSet added in v0.35.0 

func DeleteTokenChoicesSet(db ethdb.KeyValueWriter, blockHash common.Hash)

func DeleteTrieNode 

func DeleteTrieNode(db ethdb.KeyValueWriter, hash common.Hash)

DeleteTrieNode deletes the specified trie node from the database.

func DeleteTrimmedUTXOs added in v0.35.0 

func DeleteTrimmedUTXOs(db ethdb.KeyValueWriter, blockHash common.Hash)

func DeleteTxLookupEntries 

func DeleteTxLookupEntries(db ethdb.KeyValueWriter, hashes []common.Hash)

DeleteTxLookupEntries removes all transaction lookups for a given block.

func DeleteTxLookupEntry 

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

DeleteTxLookupEntry removes all transaction data associated with a hash.

func DeleteUTXO added in v0.32.0 

func DeleteUTXO(db ethdb.KeyValueWriter, txHash common.Hash, index uint16)

func DeleteUTXOSetSize added in v0.35.0 

func DeleteUTXOSetSize(db ethdb.KeyValueWriter, blockHash common.Hash)

func DeleteUtxoToBlockHeight added in v0.39.0 

func DeleteUtxoToBlockHeight(db ethdb.KeyValueWriter, txHash common.Hash, index uint16)

func DeleteWorkObject added in v0.29.0 

func DeleteWorkObject(db ethdb.KeyValueWriter, hash common.Hash, number uint64, woType types.WorkObjectView)

DeleteWorkObject deletes the work object stored for the header hash.

func DeleteWorkObjectBody added in v0.29.0 

func DeleteWorkObjectBody(db ethdb.KeyValueWriter, hash common.Hash)

DeleteWorkObjectBody deletes the work object body stored for the header hash.

func DeleteWorkObjectHeader added in v0.29.0 

func DeleteWorkObjectHeader(db ethdb.KeyValueWriter, number uint64, hash common.Hash, woType types.WorkObjectView)

DeleteWorkObjectHeader deletes the work object header stored for the header hash.

func FindCommonAncestor 

func FindCommonAncestor(db ethdb.Reader, a, b *types.WorkObject, nodeCtx int) (*types.WorkObject, error)

FindCommonAncestor returns the last common ancestor of two block headers

func GetUTXO added in v0.32.0 

func GetUTXO(db ethdb.KeyValueReader, txHash common.Hash, index uint16) *types.UtxoEntry

func GetUTXOWithBatch added in v0.41.0 

func GetUTXOWithBatch(db ethdb.KeyValueReader, batch ethdb.Batch, txHash common.Hash, index uint16) *types.UtxoEntry

func HasBody 

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

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

func HasHeader 

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

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

func InitDatabaseFromFreezer 

func InitDatabaseFromFreezer(db ethdb.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 

func InspectDatabase(db ethdb.Database, keyPrefix, keyStart []byte, logger *log.Logger) error

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

func IsCodeKey 

func IsCodeKey(key []byte) (bool, []byte)

IsCodeKey reports whether the given byte slice is the key of contract code, if so return the raw code hash as well.

func IsGenesisHash added in v0.32.0 

func IsGenesisHash(db ethdb.Reader, hash common.Hash) bool

func IterateStorageSnapshots 

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

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

func NewDatabase 

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

func NewDatabaseWithFreezer(db ethdb.KeyValueStore, freezer string, namespace string, readonly bool, nodeCtx int, logger *log.Logger, location common.Location) (ethdb.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 NewFreezerTable 

func NewFreezerTable(path, name string, disableSnappy bool, logger *log.Logger) (*freezerTable, error)

NewFreezerTable opens the given path as a freezer table.

func NewLevelDBDatabase 

func NewLevelDBDatabase(file string, cache int, handles int, namespace string, readonly bool, logger *log.Logger, location common.Location) (ethdb.Database, error)

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

func NewMemoryDatabase 

func NewMemoryDatabase(logger *log.Logger) ethdb.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) ethdb.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 NewPebbleDBDatabase 

func NewPebbleDBDatabase(file string, cache int, handles int, namespace string, readonly bool, logger *log.Logger, location common.Location) (ethdb.Database, error)

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

func NewTable 

func NewTable(db ethdb.Database, prefix string, location common.Location, logger *log.Logger) ethdb.Database

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

func Open 

func Open(o OpenOptions, nodeCtx int, logger *log.Logger, location common.Location) (ethdb.Database, error)

Open opens both a disk-based key-value database such as leveldb or pebble, but also integrates it with a freezer database -- if the AncientDir option has been set on the provided OpenOptions. The passed o.AncientDir indicates the path of root ancient directory where the chain freezer can be opened.

func ReadAccountSnapshot 

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

ReadAccountSnapshot retrieves the snapshot entry of an account trie leaf.

func ReadAllHashes 

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

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

func ReadAlreadyPruned added in v0.35.0 

func ReadAlreadyPruned(db ethdb.Reader, blockHash common.Hash) bool

func ReadBadHashesList 

func ReadBadHashesList(db ethdb.Reader) common.Hashes

ReadBadHashesList retreives the bad hashes corresponding to the recent fork

func ReadBestPendingHeader added in v0.32.0 

func ReadBestPendingHeader(db ethdb.Reader) *types.WorkObject

ReadBestPendingHeader retreive's the pending header stored in hash.

func ReadBetas added in v0.35.0 

func ReadBetas(db ethdb.KeyValueReader, blockHash common.Hash) *types.Betas

func ReadBloom 

func ReadBloom(db ethdb.Reader, hash common.Hash) *types.Bloom

ReadBloom retreives the bloom corresponding to a given block

func ReadBloomBits 

func ReadBloomBits(db ethdb.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 ReadBloomProto added in v0.29.0 

func ReadBloomProto(db ethdb.Reader, hash common.Hash) []byte

ReadBloomProto retrieves the bloom for the given block, in bytes

func ReadCanonicalHash 

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

ReadCanonicalHash retrieves the hash assigned to a canonical block number.

func ReadChainConfig 

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

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

func ReadCode 

func ReadCode(db ethdb.KeyValueReader, hash common.Hash) []byte

ReadCode retrieves the contract code of the provided code hash.

func ReadCodeWithPrefix 

func ReadCodeWithPrefix(db ethdb.KeyValueReader, hash common.Hash) []byte

ReadCodeWithPrefix retrieves the contract code of the provided code hash. The main difference between this function and ReadCode is this function will only check the existence with latest scheme(with prefix).

func ReadCreatedUTXOKeys added in v0.32.0 

func ReadCreatedUTXOKeys(db ethdb.Reader, blockHash common.Hash) ([][]byte, error)

func ReadDatabaseVersion 

func ReadDatabaseVersion(db ethdb.KeyValueReader) *uint64

ReadDatabaseVersion retrieves the version number of the database.

func ReadGenesisHashes added in v0.29.0 

func ReadGenesisHashes(db ethdb.Reader) common.Hashes

func ReadHeadBlock 

func ReadHeadBlock(db ethdb.Reader) *types.WorkObject

ReadHeadBlock returns the current canonical head block.

func ReadHeadBlockHash 

func ReadHeadBlockHash(db ethdb.KeyValueReader) common.Hash

ReadHeadBlockHash retrieves the hash of the current canonical head block.

func ReadHeadHeaderHash 

func ReadHeadHeaderHash(db ethdb.KeyValueReader) common.Hash

ReadHeadHeaderHash retrieves the hash of the current canonical head header.

func ReadHeader 

func ReadHeader(db ethdb.Reader, number uint64, hash common.Hash) *types.WorkObject

ReadHeader retrieves the block header corresponding to the hash.

func ReadHeaderNumber 

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

ReadHeaderNumber returns the header number assigned to a hash.

func ReadHeadsHashes 

func ReadHeadsHashes(db ethdb.Reader) common.Hashes

ReadHeadsHashes retreive's the heads hashes of the blockchain.

func ReadInboundEtxs 

func ReadInboundEtxs(db ethdb.Reader, hash common.Hash) types.Transactions

ReadInboundEtxs reads the inbound etxs from the database

func ReadInterlinkHashes added in v0.29.0 

func ReadInterlinkHashes(db ethdb.Reader, hash common.Hash) common.Hashes

ReadInterlinkHashes retreives the interlinkhashes corresponding to a given block

func ReadLastTrimmedBlock added in v0.35.0 

func ReadLastTrimmedBlock(db ethdb.Reader, blockHash common.Hash) uint64

func ReadLockupsForAddress added in v0.41.0 

func ReadLockupsForAddress(db ethdb.Database, address common.Address) ([]*types.Lockup, error)

func ReadLockupsForAddressAtBlock added in v0.41.0 

func ReadLockupsForAddressAtBlock(db ethdb.Reader, address [20]byte) ([]*types.Lockup, error)

func ReadManifest 

func ReadManifest(db ethdb.Reader, hash common.Hash) types.BlockManifest

ReadManifest retreives the manifest corresponding to a given block

func ReadMultiSet added in v0.32.0 

func ReadMultiSet(db ethdb.Reader, blockHash common.Hash) *multiset.MultiSet

func ReadOutpointsForAddress added in v0.30.0 

func ReadOutpointsForAddress(db ethdb.Database, address common.Address) ([]*types.OutpointAndDenomination, error)

func ReadOutpointsForAddressAtBlock added in v0.39.0 

func ReadOutpointsForAddressAtBlock(db ethdb.Reader, address [20]byte) ([]*types.OutpointAndDenomination, error)

func ReadPbBodyKeys 

func ReadPbBodyKeys(db ethdb.Reader) common.Hashes

ReadPbBodyKeys retreive's the phBodyKeys of the worker

func ReadPbCacheBody 

func ReadPbCacheBody(db ethdb.Reader, hash common.Hash) *types.WorkObject

ReadPbCacheBody retrieves the block body corresponding to the hash.

func ReadPendingEtxs 

func ReadPendingEtxs(db ethdb.Reader, hash common.Hash) *types.PendingEtxs

ReadPendingEtxs retreives the pending ETXs corresponding to a given block

func ReadPendingEtxsProto added in v0.29.0 

func ReadPendingEtxsProto(db ethdb.Reader, hash common.Hash) []byte

ReadPendingEtxsProto retrieves the set of pending ETXs for the given block, in Proto encoding

func ReadPendingEtxsRollup 

func ReadPendingEtxsRollup(db ethdb.Reader, hash common.Hash) *types.PendingEtxsRollup

ReadPendingEtxsRollup retreives the pending ETXs rollup corresponding to a given block

func ReadPreimage 

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

ReadPreimage retrieves a single preimage of the provided hash.

func ReadProcessedState added in v0.29.0 

func ReadProcessedState(db ethdb.KeyValueReader, hash common.Hash) bool

func ReadPrunedUTXOKeys added in v0.35.0 

func ReadPrunedUTXOKeys(db ethdb.Reader, blockHeight uint64) ([][]byte, error)

func ReadRawReceipts 

func ReadRawReceipts(db ethdb.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 ReadReceipts 

func ReadReceipts(db ethdb.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 ReadReceiptsProto added in v0.29.0 

func ReadReceiptsProto(db ethdb.Reader, hash common.Hash, number uint64) []byte

ReadReceiptsProto retrieves all the transaction receipts belonging to a block in Proto encoding.

func ReadSnapshotDisabled 

func ReadSnapshotDisabled(db ethdb.KeyValueReader) bool

ReadSnapshotDisabled retrieves if the snapshot maintenance is disabled.

func ReadSnapshotGenerator 

func ReadSnapshotGenerator(db ethdb.KeyValueReader) []byte

ReadSnapshotGenerator retrieves the serialized snapshot generator saved at the last shutdown.

func ReadSnapshotJournal 

func ReadSnapshotJournal(db ethdb.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 ReadSnapshotRecoveryNumber 

func ReadSnapshotRecoveryNumber(db ethdb.KeyValueReader) *uint64

ReadSnapshotRecoveryNumber retrieves the block number of the last persisted snapshot layer.

func ReadSnapshotRoot 

func ReadSnapshotRoot(db ethdb.KeyValueReader) common.Hash

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

func ReadSnapshotSyncStatus 

func ReadSnapshotSyncStatus(db ethdb.KeyValueReader) []byte

ReadSnapshotSyncStatus retrieves the serialized sync status saved at shutdown.

func ReadSpentUTXOs added in v0.32.0 

func ReadSpentUTXOs(db ethdb.Reader, blockHash common.Hash) ([]*types.SpentUtxoEntry, error)

func ReadStorageSnapshot 

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

ReadStorageSnapshot retrieves the snapshot entry of an storage trie leaf.

func ReadTermini 

func ReadTermini(db ethdb.Reader, hash common.Hash) *types.Termini

ReadHeadsHashes retreive's the heads hashes of the blockchain.

func ReadTokenChoicesSet added in v0.35.0 

func ReadTokenChoicesSet(db ethdb.Reader, blockHash common.Hash) *types.TokenChoiceSet

func ReadTransaction 

func ReadTransaction(db ethdb.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 ReadTrieNode 

func ReadTrieNode(db ethdb.KeyValueReader, hash common.Hash) []byte

ReadTrieNode retrieves the trie node of the provided hash.

func ReadTrimmedUTXOs added in v0.35.0 

func ReadTrimmedUTXOs(db ethdb.Reader, blockHash common.Hash) ([]*types.SpentUtxoEntry, error)

func ReadTxLookupEntry 

func ReadTxLookupEntry(db ethdb.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 ReadUTXOSetSize added in v0.35.0 

func ReadUTXOSetSize(db ethdb.Reader, blockHash common.Hash) uint64

func ReadUtxoToBlockHeight added in v0.39.0 

func ReadUtxoToBlockHeight(db ethdb.Reader, txHash common.Hash, index uint16) uint32

ReadUtxoToBlockHeight reads the block height at which a UTXO was created This is not meant to be used in consensus. It is only used in the UTXO indexer or RPC API.

func ReadWorkObject added in v0.29.0 

func ReadWorkObject(db ethdb.Reader, number uint64, hash common.Hash, woType types.WorkObjectView) *types.WorkObject

ReadWorkObject retreive's the work object stored in hash.

func ReadWorkObjectBody added in v0.29.0 

func ReadWorkObjectBody(db ethdb.Reader, hash common.Hash, woType types.WorkObjectView) *types.WorkObjectBody

ReadWorkObjectBody retreive's the work object body stored in hash.

func ReadWorkObjectBodyHeaderOnly added in v0.29.0 

func ReadWorkObjectBodyHeaderOnly(db ethdb.Reader, hash common.Hash) *types.WorkObjectBody

func ReadWorkObjectHeader added in v0.29.0 

func ReadWorkObjectHeader(db ethdb.Reader, number uint64, hash common.Hash, woType types.WorkObjectView) *types.WorkObjectHeader

ReadWorkObjectHeader retreive's the work object header stored in hash.

func ReadWorkObjectHeaderOnly added in v0.29.0 

func ReadWorkObjectHeaderOnly(db ethdb.Reader, number uint64, hash common.Hash, woType types.WorkObjectView) *types.WorkObject

func ReadWorkObjectWithWorkShares added in v0.30.0 

func ReadWorkObjectWithWorkShares(db ethdb.Reader, number uint64, hash common.Hash) *types.WorkObject

ReadWorkObjectWithWorkShares retreive's the work object stored in hash.

func ReverseUtxoKey added in v0.35.0 

func ReverseUtxoKey(key []byte) (common.Hash, uint16, error)

func UtxoKey added in v0.32.0 

func UtxoKey(hash common.Hash, index uint16) []byte

This can be optimized via VLQ encoding as btcd has done this key is 36 bytes long and can probably be reduced to 32 bytes

func UtxoKeyWithDenomination added in v0.35.0 

func UtxoKeyWithDenomination(hash common.Hash, index uint16, denomination uint8) []byte

func WriteAccountSnapshot 

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

WriteAccountSnapshot stores the snapshot entry of an account trie leaf.

func WriteAddressLockups added in v0.41.0 

func WriteAddressLockups(db ethdb.KeyValueWriter, lockupMap map[[20]byte][]*types.Lockup) error

func WriteAddressOutpoints added in v0.30.0 

func WriteAddressOutpoints(db ethdb.KeyValueWriter, outpointMap map[[20]byte][]*types.OutpointAndDenomination) error

func WriteAlreadyPruned added in v0.35.0 

func WriteAlreadyPruned(db ethdb.KeyValueWriter, blockHash common.Hash)

func WriteBadHashesList 

func WriteBadHashesList(db ethdb.KeyValueWriter, badHashes common.Hashes)

WriteBadHashesList stores the bad hashes corresponding to the recent fork

func WriteBestPendingHeader added in v0.32.0 

func WriteBestPendingHeader(db ethdb.KeyValueWriter, pendingHeader *types.WorkObject)

WriteBestPendingHeader writes the pending header of the terminus hash.

func WriteBestPhKey 

func WriteBestPhKey(db ethdb.KeyValueWriter, bestPhKey common.Hash)

WriteBestPhKey writes the bestPhKey of the blockchain

func WriteBetas added in v0.35.0 

func WriteBetas(db ethdb.KeyValueWriter, blockHash common.Hash, beta0, beta1 *big.Float) error

func WriteBloom 

func WriteBloom(db ethdb.KeyValueWriter, hash common.Hash, bloom types.Bloom)

WriteBloom stores the bloom corresponding to a given block

func WriteBloomBits 

func WriteBloomBits(db ethdb.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 WriteBloomProto added in v0.29.0 

func WriteBloomProto(db ethdb.KeyValueWriter, hash common.Hash, data []byte)

WriteBloomProto stores the bloom corresponding to a given block, in proto bug encoding

func WriteCanonicalHash 

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

WriteCanonicalHash stores the hash assigned to a canonical block number.

func WriteChainConfig 

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

WriteChainConfig writes the chain config settings to the database.

func WriteCode 

func WriteCode(db ethdb.KeyValueWriter, hash common.Hash, code []byte)

WriteCode writes the provided contract code database.

func WriteCreatedUTXOKeys added in v0.32.0 

func WriteCreatedUTXOKeys(db ethdb.KeyValueWriter, blockHash common.Hash, createdUTXOKeys [][]byte) error

func WriteDatabaseVersion 

func WriteDatabaseVersion(db ethdb.KeyValueWriter, version uint64)

WriteDatabaseVersion stores the version number of the database

func WriteGenesisHashes added in v0.29.0 

func WriteGenesisHashes(db ethdb.KeyValueWriter, hashes common.Hashes)

func WriteHeadBlockHash 

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

WriteHeadBlockHash stores the head block's hash.

func WriteHeadHeaderHash 

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

WriteHeadHeaderHash stores the hash of the current canonical head header.

func WriteHeaderNumber 

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

WriteHeaderNumber stores the hash->number mapping.

func WriteHeadsHashes 

func WriteHeadsHashes(db ethdb.KeyValueWriter, hashes common.Hashes)

WriteHeadsHashes writes the heads hashes of the blockchain.

func WriteInboundEtxs 

func WriteInboundEtxs(db ethdb.KeyValueWriter, hash common.Hash, inboundEtxs types.Transactions)

WriteInboundEtxs stores the inbound etxs for a given dom block hashes

func WriteInterlinkHashes added in v0.29.0 

func WriteInterlinkHashes(db ethdb.KeyValueWriter, hash common.Hash, interlinkHashes common.Hashes)

WriteInterlinkHashes stores the interlink hashes corresponding to a given block

func WriteLastTrimmedBlock added in v0.35.0 

func WriteLastTrimmedBlock(db ethdb.KeyValueWriter, blockHash common.Hash, blockHeight uint64)

func WriteLockupsForAddressAtBlock added in v0.41.0 

func WriteLockupsForAddressAtBlock(db ethdb.KeyValueWriter, address [20]byte, lockups []*types.Lockup) error

func WriteManifest 

func WriteManifest(db ethdb.KeyValueWriter, hash common.Hash, manifest types.BlockManifest)

WriteManifest stores the manifest corresponding to a given block

func WriteMultiSet added in v0.32.0 

func WriteMultiSet(db ethdb.KeyValueWriter, blockHash common.Hash, multiSet *multiset.MultiSet)

func WriteOutpointsForAddressAndBlockHeight added in v0.39.0 

func WriteOutpointsForAddressAndBlockHeight(db ethdb.KeyValueWriter, address [20]byte, outpoints []*types.OutpointAndDenomination) error

func WritePbBodyKeys 

func WritePbBodyKeys(db ethdb.KeyValueWriter, hashes common.Hashes)

WritePbBodyKeys writes the workers pendingHeaderBody keys to the db

func WritePbCacheBody 

func WritePbCacheBody(db ethdb.KeyValueWriter, hash common.Hash, body *types.WorkObject)

WritePbCacheBody stores a block body into the database.

func WritePendingEtxs 

func WritePendingEtxs(db ethdb.KeyValueWriter, pendingEtxs types.PendingEtxs)

WritePendingEtxs stores the pending ETXs corresponding to a given block

func WritePendingEtxsProto added in v0.29.0 

func WritePendingEtxsProto(db ethdb.KeyValueWriter, hash common.Hash, data []byte)

WritePendingEtxsProto stores the pending ETXs corresponding to a given block, in Proto encoding.

func WritePendingEtxsRollup 

func WritePendingEtxsRollup(db ethdb.KeyValueWriter, pendingEtxsRollup types.PendingEtxsRollup)

WritePendingEtxsRollup stores the pending ETXs rollup corresponding to a given block

func WritePreimages 

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

WritePreimages writes the provided set of preimages to the database.

func WriteProcessedState added in v0.29.0 

func WriteProcessedState(db ethdb.KeyValueWriter, hash common.Hash)

func WritePrunedUTXOKeys added in v0.35.0 

func WritePrunedUTXOKeys(db ethdb.KeyValueWriter, blockHeight uint64, keys [][]byte) error

func WriteReceipts 

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

WriteReceipts stores all the transaction receipts belonging to a block.

func WriteSnapshotDisabled 

func WriteSnapshotDisabled(db ethdb.KeyValueWriter)

WriteSnapshotDisabled stores the snapshot pause flag.

func WriteSnapshotGenerator 

func WriteSnapshotGenerator(db ethdb.KeyValueWriter, generator []byte)

WriteSnapshotGenerator stores the serialized snapshot generator to save at shutdown.

func WriteSnapshotJournal 

func WriteSnapshotJournal(db ethdb.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 WriteSnapshotRecoveryNumber 

func WriteSnapshotRecoveryNumber(db ethdb.KeyValueWriter, number uint64)

WriteSnapshotRecoveryNumber stores the block number of the last persisted snapshot layer.

func WriteSnapshotRoot 

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

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

func WriteSnapshotSyncStatus 

func WriteSnapshotSyncStatus(db ethdb.KeyValueWriter, status []byte)

WriteSnapshotSyncStatus stores the serialized sync status to save at shutdown.

func WriteSpentUTXOs added in v0.32.0 

func WriteSpentUTXOs(db ethdb.KeyValueWriter, blockHash common.Hash, spentUTXOs []*types.SpentUtxoEntry) error

func WriteStorageSnapshot 

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

WriteStorageSnapshot stores the snapshot entry of an storage trie leaf.

func WriteTermini 

func WriteTermini(db ethdb.KeyValueWriter, index common.Hash, hashes types.Termini)

WriteTermini writes the heads hashes of the blockchain.

func WriteTokenChoicesSet added in v0.35.0 

func WriteTokenChoicesSet(db ethdb.KeyValueWriter, blockHash common.Hash, tokenChoiceSet *types.TokenChoiceSet) error

func WriteTrieNode 

func WriteTrieNode(db ethdb.KeyValueWriter, hash common.Hash, node []byte)

WriteTrieNode writes the provided trie node database.

func WriteTrimmedUTXOs added in v0.35.0 

func WriteTrimmedUTXOs(db ethdb.KeyValueWriter, blockHash common.Hash, spentUTXOs []*types.SpentUtxoEntry) error

func WriteTxLookupEntries 

func WriteTxLookupEntries(db ethdb.KeyValueWriter, number uint64, hashes []common.Hash)

WriteTxLookupEntries is identical to WriteTxLookupEntry, but it works on a list of hashes

func WriteTxLookupEntriesByBlock 

func WriteTxLookupEntriesByBlock(db ethdb.KeyValueWriter, wo *types.WorkObject, nodeCtx int)

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

func WriteUTXOSetSize added in v0.35.0 

func WriteUTXOSetSize(db ethdb.KeyValueWriter, blockHash common.Hash, size uint64)

func WriteUtxoToBlockHeight added in v0.39.0 

func WriteUtxoToBlockHeight(db ethdb.KeyValueWriter, txHash common.Hash, index uint16, blockHeight uint32)

func WriteWorkObject added in v0.29.0 

func WriteWorkObject(db ethdb.KeyValueWriter, hash common.Hash, workObject *types.WorkObject, woType types.WorkObjectView, nodeCtx int)

WriteWorkObject writes the work object of the terminus hash.

func WriteWorkObjectBody added in v0.29.0 

func WriteWorkObjectBody(db ethdb.KeyValueWriter, hash common.Hash, workObject *types.WorkObject, woType types.WorkObjectView, nodeCtx int)

WriteWorkObjectBody writes the work object body of the terminus hash.

func WriteWorkObjectHeader added in v0.29.0 

func WriteWorkObjectHeader(db ethdb.KeyValueWriter, hash common.Hash, workObject *types.WorkObject, woType types.WorkObjectView, nodeCtx int)

WriteWorkObjectHeader writes the work object header of the terminus hash.

Types

type LegacyTxLookupEntry 

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

LegacyTxLookupEntry is the legacy TxLookupEntry definition with some unnecessary fields.

func (*LegacyTxLookupEntry) ProtoDecode added in v0.29.0 

func (l *LegacyTxLookupEntry) ProtoDecode(data *ProtoLegacyTxLookupEntry) error

func (LegacyTxLookupEntry) ProtoEncode added in v0.29.0 

func (l LegacyTxLookupEntry) ProtoEncode() (ProtoLegacyTxLookupEntry, error)

type OpenOptions 

type OpenOptions struct {
	Type              string // "leveldb" | "pebble"
	Directory         string // the datadir
	AncientsDirectory string // the ancients-dir
	Namespace         string // the namespace for database relevant metrics
	Cache             int    // the capacity(in megabytes) of the data caching
	Handles           int    // number of files to be open simultaneously
	ReadOnly          bool
}

OpenOptions contains the options to apply when opening a database. OBS: If AncientsDirectory is empty, it indicates that no freezer is to be used.

type ProtoLegacyTxLookupEntry added in v0.29.0 

type ProtoLegacyTxLookupEntry struct {
	Hash       *common.ProtoHash `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"`
	BlockIndex uint64            `protobuf:"varint,2,opt,name=block_index,json=blockIndex,proto3" json:"block_index,omitempty"`
	Index      uint64            `protobuf:"varint,3,opt,name=index,proto3" json:"index,omitempty"`
	// contains filtered or unexported fields
}

func (*ProtoLegacyTxLookupEntry) Descriptor deprecated added in v0.29.0 

func (*ProtoLegacyTxLookupEntry) Descriptor() ([]byte, []int)

Deprecated: Use ProtoLegacyTxLookupEntry.ProtoReflect.Descriptor instead.

func (*ProtoLegacyTxLookupEntry) GetBlockIndex added in v0.29.0 

func (x *ProtoLegacyTxLookupEntry) GetBlockIndex() uint64

func (*ProtoLegacyTxLookupEntry) GetHash added in v0.29.0 

func (x *ProtoLegacyTxLookupEntry) GetHash() *common.ProtoHash

func (*ProtoLegacyTxLookupEntry) GetIndex added in v0.29.0 

func (x *ProtoLegacyTxLookupEntry) GetIndex() uint64

func (*ProtoLegacyTxLookupEntry) ProtoMessage added in v0.29.0 

func (*ProtoLegacyTxLookupEntry) ProtoMessage()

func (*ProtoLegacyTxLookupEntry) ProtoReflect added in v0.29.0 

func (x *ProtoLegacyTxLookupEntry) ProtoReflect() protoreflect.Message

func (*ProtoLegacyTxLookupEntry) Reset added in v0.29.0 

func (x *ProtoLegacyTxLookupEntry) Reset()

func (*ProtoLegacyTxLookupEntry) String added in v0.29.0 

func (x *ProtoLegacyTxLookupEntry) String() string

type ProtoNumber added in v0.29.0 

type ProtoNumber struct {
	Number uint64 `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"`
	// contains filtered or unexported fields
}

func (*ProtoNumber) Descriptor deprecated added in v0.29.0 

func (*ProtoNumber) Descriptor() ([]byte, []int)

Deprecated: Use ProtoNumber.ProtoReflect.Descriptor instead.

func (*ProtoNumber) GetNumber added in v0.29.0 

func (x *ProtoNumber) GetNumber() uint64

func (*ProtoNumber) ProtoMessage added in v0.29.0 

func (*ProtoNumber) ProtoMessage()

func (*ProtoNumber) ProtoReflect added in v0.29.0 

func (x *ProtoNumber) ProtoReflect() protoreflect.Message

func (*ProtoNumber) Reset added in v0.29.0 

func (x *ProtoNumber) Reset()

func (*ProtoNumber) String added in v0.29.0 

func (x *ProtoNumber) String() string

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.