cerc-io/plugeth-statediff
16
0
Fork 0
Code Issues 3 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

godoc for indexer

Browse Source
This commit is contained in:
Roy Crihfield 2023-09-28 11:48:15 +08:00
parent cfa64279da
commit 175b7b9968
1 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
indexer/interfaces/interfaces.go
View File

@ -29,27 +29,39 @@ import (
"github.com/ethereum/go-ethereum/core/types" "github.com/ethereum/go-ethereum/core/types"
) )
// StateDiffIndexer interface required to index statediff data // StateDiffIndexer describes the interface for indexing state data.
type StateDiffIndexer interface { type StateDiffIndexer interface {
DetectGaps(beginBlock uint64, endBlock uint64) ([]*BlockGap, error) // PushBlock indexes block data except for state & storage nodes: header, uncles, transactions &
CurrentBlock() (*models.HeaderModel, error) // receipts. Returns an initiated DB transaction which must be committed or rolled back.
HasBlock(hash common.Hash, number uint64) (bool, error)
PushBlock(block *types.Block, receipts types.Receipts, totalDifficulty *big.Int) (Batch, error) PushBlock(block *types.Block, receipts types.Receipts, totalDifficulty *big.Int) (Batch, error)
// PushHeader indexes a block header.
PushHeader(batch Batch, header *types.Header, reward, td *big.Int) (string, error) PushHeader(batch Batch, header *types.Header, reward, td *big.Int) (string, error)
// PushStateNode indexes a state node and its storage trie.
PushStateNode(tx Batch, stateNode sdtypes.StateLeafNode, headerID string) error PushStateNode(tx Batch, stateNode sdtypes.StateLeafNode, headerID string) error
// PushIPLD indexes an IPLD node.
PushIPLD(tx Batch, ipld sdtypes.IPLD) error PushIPLD(tx Batch, ipld sdtypes.IPLD) error
ReportDBMetrics(delay time.Duration, quit <-chan bool) // BeginTx starts a new DB transaction.
BeginTx(number *big.Int, ctx context.Context) Batch BeginTx(number *big.Int, ctx context.Context) Batch
// DetectGaps returns a list of gaps in the block range, if any.
DetectGaps(beginBlock uint64, endBlock uint64) ([]*BlockGap, error)
// CurrentBlock returns the latest indexed block.
CurrentBlock() (*models.HeaderModel, error)
// HasBlock returns true if the block is indexed.
HasBlock(hash common.Hash, number uint64) (bool, error)
// Close closes the associated output DB connection or files.
Close() error
// Methods used by WatchAddress API/functionality // Methods used by WatchAddress API/functionality
LoadWatchedAddresses() ([]common.Address, error) LoadWatchedAddresses() ([]common.Address, error)
InsertWatchedAddresses(addresses []sdtypes.WatchAddressArg, currentBlock *big.Int) error InsertWatchedAddresses(addresses []sdtypes.WatchAddressArg, currentBlock *big.Int) error
RemoveWatchedAddresses(addresses []sdtypes.WatchAddressArg) error RemoveWatchedAddresses(addresses []sdtypes.WatchAddressArg) error
SetWatchedAddresses(args []sdtypes.WatchAddressArg, currentBlockNumber *big.Int) error SetWatchedAddresses(args []sdtypes.WatchAddressArg, currentBlockNumber *big.Int) error
ClearWatchedAddresses() error ClearWatchedAddresses() error
Close() error ReportDBMetrics(delay time.Duration, quit <-chan bool)
} }
// Batch required for indexing data atomically // Batch required for indexing data atomically